Doxygen related fixesdoxygen_fixes

3 files changed, 15 insertions, 15 deletions

diff --git a/doc/doxygen.cfg.in b/doc/doxygen.cfg.in
index 67c5b13..d8f130a 100644
--- a/doc/doxygen.cfg.in
+++ b/doc/doxygen.cfg.in
@@ -76,7 +76,7 @@ CREATE_SUBDIRS         = NO
 # U+3044.
 # The default value is: NO.
 
-ALLOW_UNICODE_NAMES    = NO
+#ALLOW_UNICODE_NAMES    = NO
 
 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
 # documentation generated by doxygen is written. Doxygen will use this
@@ -152,7 +152,7 @@ FULL_PATH_NAMES        = YES
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        = src/
+STRIP_FROM_PATH        = src/ include/
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
@@ -751,7 +751,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @top_srcdir@/src
+INPUT                  = @top_srcdir@/src @top_srcdir@/include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1780,7 +1780,7 @@ MAN_EXTENSION          = .3
 # MAN_EXTENSION with the initial . removed.
 # This tag requires that the tag GENERATE_MAN is set to YES.
 
-MAN_SUBDIR             =
+#MAN_SUBDIR             =
 
 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
 # will generate one additional man file for each entity documented in the real
@@ -1843,7 +1843,7 @@ DOCBOOK_OUTPUT         = docbook
 # The default value is: NO.
 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
 
-DOCBOOK_PROGRAMLISTING = NO
+#DOCBOOK_PROGRAMLISTING = NO
 
 #---------------------------------------------------------------------------
 # Configuration options for the AutoGen Definitions output
@@ -2267,7 +2267,7 @@ DIAFILE_DIRS           =
 # will not generate output for the diagram.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-PLANTUML_JAR_PATH      =
+#PLANTUML_JAR_PATH      =
 
 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
 # that will be shown in the graph. If the number of nodes in a graph becomes
diff --git a/src/erasurecode.c b/src/erasurecode.c
index 13e5f02..0d04f62 100644
--- a/src/erasurecode.c
+++ b/src/erasurecode.c
@@ -231,7 +231,7 @@ liberasurecode_exit(void) {
  *
  * @param id - one of the supported backends as
  *        defined by ec_backend_id_t
- * @param ec_args - arguments to the EC backend
+ * @param args - arguments to the EC backend
  *        arguments common to all backends
  *          k - number of data fragments
  *          m - number of parity fragments
@@ -298,7 +298,7 @@ int liberasurecode_instance_create(const ec_backend_id_t id,
 /**
  * Close a liberasurecode instance
  *
- * @param liberasurecode descriptor to close
+ * @param desc - liberasurecode descriptor to close
  */
 int liberasurecode_instance_destroy(int desc)
 {
@@ -506,7 +506,7 @@ int liberasurecode_decode_cleanup(int desc, char *data)
  *
  * @param desc - liberasurecode descriptor/handle
  *        from liberasurecode_instance_create()
- * @param fragments - erasure encoded fragments (> = k)
+ * @param available_fragments - erasure encoded fragments (> = k)
  * @param num_fragments - number of fragments being passed in
  * @param fragment_len - length of each fragment (assume they are the same)
  * @param force_metadata_checks - force fragment metadata checks (default: 0)
@@ -907,12 +907,12 @@ out:
  * Return a list of lists with valid rebuild indexes given
  * a list of missing indexes.
  *
- * @desc: liberasurecode instance descriptor (obtained with
+ * @param desc - liberasurecode instance descriptor (obtained with
  *        liberasurecode_instance_create)
- * @fragments_to_reconstruct list of indexes to reconstruct
- * @fragments_to_exclude list of indexes to exclude from
+ * @param fragments_to_reconstruct - list of indexes to reconstruct
+ * @param fragments_to_exclude - list of indexes to exclude from
           reconstruction equation
- * @fragments_needed list of fragments needed to reconstruct
+ * @param fragments_needed - list of fragments needed to reconstruct
           fragments in fragments_to_reconstruct
  *
  * @return a list of lists (bitmaps) of indexes to rebuild data
diff --git a/src/erasurecode_helpers.c b/src/erasurecode_helpers.c
index c9fa288..53941cf 100644
--- a/src/erasurecode_helpers.c
+++ b/src/erasurecode_helpers.c
@@ -177,8 +177,8 @@ uint64_t get_fragment_size(char *buf)
  * Compute a size aligned to the number of data and the underlying wordsize 
  * of the EC algorithm.
  * 
- * @param instance, ec_backend_t instance (to extract args)
- * @param data_len, integer length of data in bytes
+ * @param instance - ec_backend_t instance (to extract args)
+ * @param data_len - integer length of data in bytes
  * @return integer data length aligned with wordsize of EC algorithm
  */
 int get_aligned_data_size(ec_backend_t instance, int data_len)