summaryrefslogtreecommitdiff
path: root/rpmio/rpmmacro.h
diff options
context:
space:
mode:
authorPanu Matilainen <pmatilai@redhat.com>2007-11-23 14:39:51 +0200
committerPanu Matilainen <pmatilai@redhat.com>2007-11-23 14:39:51 +0200
commita1cab56e703bb1dcab70384631dd081070194db4 (patch)
tree4ee1899680d6351e23ae8685b8d89798a7f04646 /rpmio/rpmmacro.h
parent975aa86c3709c61dd452b3c2930500b839f55f17 (diff)
downloadrpm-a1cab56e703bb1dcab70384631dd081070194db4.tar.gz
rpm-a1cab56e703bb1dcab70384631dd081070194db4.tar.bz2
rpm-a1cab56e703bb1dcab70384631dd081070194db4.zip
Add doxygen group for macros, include in librpm + hacking docs
Diffstat (limited to 'rpmio/rpmmacro.h')
-rw-r--r--rpmio/rpmmacro.h22
1 files changed, 11 insertions, 11 deletions
diff --git a/rpmio/rpmmacro.h b/rpmio/rpmmacro.h
index 51257a953..9fb866354 100644
--- a/rpmio/rpmmacro.h
+++ b/rpmio/rpmmacro.h
@@ -37,7 +37,7 @@ extern const char * macrofiles;
#define RMIL_OLDSPEC -1
#define RMIL_GLOBAL 0
-/**
+/** \ingroup rpmmacro
* Print macros to file stream.
* @param mc macro context (NULL uses global context).
* @param fp file stream (NULL uses stderr).
@@ -45,7 +45,7 @@ extern const char * macrofiles;
void rpmDumpMacroTable (rpmMacroContext mc,
FILE * fp);
-/**
+/** \ingroup rpmmacro
* Expand macro into buffer.
* @deprecated Use rpmExpand().
* @todo Eliminate from API.
@@ -59,7 +59,7 @@ int expandMacros (void * spec, rpmMacroContext mc,
char * sbuf,
size_t slen);
-/**
+/** \ingroup rpmmacro
* Add macro to context.
* @deprecated Use rpmDefineMacro().
* @param mc macro context (NULL uses global context).
@@ -72,14 +72,14 @@ void addMacro (rpmMacroContext mc, const char * n,
const char * o,
const char * b, int level);
-/**
+/** \ingroup rpmmacro
* Delete macro from context.
* @param mc macro context (NULL uses global context).
* @param n macro name
*/
void delMacro (rpmMacroContext mc, const char * n);
-/**
+/** \ingroup rpmmacro
* Define macro in context.
* @param mc macro context (NULL uses global context).
* @param macro macro name, options, body
@@ -89,41 +89,41 @@ void delMacro (rpmMacroContext mc, const char * n);
int rpmDefineMacro (rpmMacroContext mc, const char * macro,
int level);
-/**
+/** \ingroup rpmmacro
* Load macros from specific context into global context.
* @param mc macro context (NULL does nothing).
* @param level macro recursion level (0 is entry API)
*/
void rpmLoadMacros (rpmMacroContext mc, int level);
-/**
+/** \ingroup rpmmacro
* Load macro context from a macro file.
* @param mc (unused)
* @param fn macro file name
*/
int rpmLoadMacroFile(rpmMacroContext mc, const char * fn);
-/**
+/** \ingroup rpmmacro
* Initialize macro context from set of macrofile(s).
* @param mc macro context
* @param macrofiles colon separated list of macro files (NULL does nothing)
*/
void rpmInitMacros (rpmMacroContext mc, const char * macrofiles);
-/**
+/** \ingroup rpmmacro
* Destroy macro context.
* @param mc macro context (NULL uses global context).
*/
void rpmFreeMacros (rpmMacroContext mc);
-/**
+/** \ingroup rpmmacro
* Return (malloc'ed) concatenated macro expansion(s).
* @param arg macro(s) to expand (NULL terminates list)
* @return macro expansion (malloc'ed)
*/
char * rpmExpand (const char * arg, ...);
-/**
+/** \ingroup rpmmacro
* Return macro expansion as a numeric value.
* Boolean values ('Y' or 'y' returns 1, 'N' or 'n' returns 0)
* are permitted as well. An undefined macro returns 0.