This change is not comprehensive; there are still documentation
comments that are not in Doxygen format.
---
lib/rpki/querySupport.c | 31 +++++++++---------
lib/rpki/querySupport.h | 83 ++++++++++++++++++++++++++++---------------------
lib/util/stringutils.h | 5 +--
3 files changed, 67 insertions(+), 52 deletions(-)
diff --git a/lib/rpki/querySupport.c b/lib/rpki/querySupport.c
index 9f3d850..88b1423 100644
--- a/lib/rpki/querySupport.c
+++ b/lib/rpki/querySupport.c
@@ -1,6 +1,7 @@
-/****************
- * Functions and flags shared by query and server code
- ****************/
+/**
+ * @file
+ * @brief Functions and flags shared by query and server code
+ */
#include "querySupport.h"
@@ -57,8 +58,8 @@ static int parentsFound;
static char *nextSKI,
*nextSubject;
-/*
- * callback to indicate that a parent was found
+/**
+ * @brief callback to indicate that a parent was found
*/
static int registerParent(
scmcon * conp,
@@ -206,8 +207,8 @@ int checkValidity(
}
-/*
- * combines dirname and filename into a pathname
+/**
+ * @brief combines dirname and filename into a pathname
*/
static int pathnameDisplay(
scm * scmp,
@@ -223,8 +224,8 @@ static int pathnameDisplay(
return 2;
}
-/*
- * create space-separated string of serial numbers
+/**
+ * @brief create space-separated string of serial numbers
*/
static int displaySNList(
scm * scmp,
@@ -476,8 +477,8 @@ static int display_ip_addrs(
return 1;
}
-/*
- * helper function for displayFlags
+/**
+ * @brief helper function for displayFlags
*/
static void addFlagIfSet(
char *returnStr,
@@ -515,8 +516,8 @@ void setIsManifest(
isManifest = val;
}
-/*
- * create list of all flags set to true
+/**
+ * @brief create list of all flags set to true
*/
static int displayFlags(
scm * scmp,
@@ -552,8 +553,8 @@ static int displayFlags(
return 1;
}
-/*
- * the set of all query fields
+/**
+ * @brief the set of all query fields
*/
static QueryField fields[] = {
{
diff --git a/lib/rpki/querySupport.h b/lib/rpki/querySupport.h
index ab14ba3..446ab01 100644
--- a/lib/rpki/querySupport.h
+++ b/lib/rpki/querySupport.h
@@ -1,21 +1,24 @@
#ifndef LIB_RPKI_QUERYSUPPORT_H
#define LIB_RPKI_QUERYSUPPORT_H
-/****************
- * Functions and flags shared by query and server code
- ****************/
+/**
+ * @file
+ * @brief Functions and flags shared by query and server code
+ */
#include "scmf.h"
-/******
- * put the appropriate tests for SCM_FLAG_XXX flags in the where
- * string of a query
- ******/
+/**
+ * @brief put the appropriate tests for @c SCM_FLAG_XXX flags in the
+ * where string of a query
+ */
extern void addQueryFlagTests(
char *whereStr,
int needAnd);
-/****** prototype for a function for displaying a field *****/
+/**
+ * @brief prototype for a function for displaying a field
+ */
typedef int (
*displayfunc) (
scm * scmp,
@@ -24,51 +27,61 @@ typedef int (
int idx1,
char *returnStr);
-/******
- * attributes of a field to display or filter on
- ******/
+/**
+ * @brief attributes of a field to display or filter on
+ */
typedef struct _QueryField {
- char *name; /* name of the field */
- char *description; /* one-line description for user help */
- int flags; /* flags (see Q_xyz above) */
- int sqlType; /* what type of data to expect from query */
- int maxSize; /* how much space to allocate for response */
- char *dbColumn; /* if not NULL, use this for query, not name */
- char *otherDBColumn; /* if not NULL, second field for query */
- char *heading; /* name of column heading to use in printout */
- displayfunc displayer; /* function for display string, NULL if std */
+ /** @brief name of the field */
+ char *name;
+ /** @brief one-line description for user help */
+ char *description;
+ /** @brief flags (see @c Q_xyz above) */
+ int flags;
+ /** @brief what type of data to expect from query */
+ int sqlType;
+ /** @brief how much space to allocate for response */
+ int maxSize;
+ /** @brief if not NULL, use this for query, not name */
+ char *dbColumn;
+ /** @brief if not NULL, second field for query */
+ char *otherDBColumn;
+ /** @brief name of column heading to use in printout */
+ char *heading;
+ /** @brief function for display string, NULL if std */
+ displayfunc displayer;
} QueryField;
-/******
- * Find the attributes of a particular field to query on
- ******/
+/**
+ * @brief Find the attributes of a particular field to query on
+ */
extern QueryField *findField(
char *name);
-/******
- * The set of all the fields
- ******/
+/**
+ * @brief The set of all the fields
+ */
extern QueryField *getFields(
void);
-/******
- * The total number of fields
- ******/
+/**
+ * @brief The total number of fields
+ */
extern int getNumFields(
void);
-/*****
- * check the valdity via the db of the cert whose ski or localID is given
- *****/
+/**
+ * @brief check the valdity via the db of the cert whose ski or
+ * localID is given
+ */
extern int checkValidity(
char *ski,
unsigned int localID,
scm * scmp,
scmcon * connect);
-/*****
- * displayFlags function needs to know if object is a manifes
- *****/
+/**
+ * @brief displayFlags() function needs to know if object is a manifes
+ */
void setIsManifest(
int val);
diff --git a/lib/util/stringutils.h b/lib/util/stringutils.h
index a06328b..c8d2733 100644
--- a/lib/util/stringutils.h
+++ b/lib/util/stringutils.h
@@ -1,8 +1,9 @@
#ifndef LIB_UTIL_STRINGUTILS_H
#define LIB_UTIL_STRINGUTILS_H
-/*
- * Low-level string parsing utilities
+/**
+ * @file
+ * @brief Low-level string parsing utilities
*/
#include "macros.h"
--
2.4.5
------------------------------------------------------------------------------
Don't Limit Your Business. Reach for the Cloud.
GigeNET's Cloud Solutions provide you with the tools and support that
you need to offload your IT needs and focus on growing your business.
Configured For All Businesses. Start Your Cloud Today.
https://www.gigenetcloud.com/
_______________________________________________
rpstir-devel mailing list
rpstir-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/rpstir-devel
