WIP

Doxyfile

@@ -32,13 +32,13 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "C API"
+PROJECT_NAME           = "Cyclone Scheme"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = 0.4
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -52,6 +52,7 @@ PROJECT_BRIEF          =
 # the logo to the output directory.
 
 PROJECT_LOGO           = 
+#PROJECT_LOGO           = docs/images/cyclone-logo-smaller.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -703,7 +704,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-LAYOUT_FILE            =
+LAYOUT_FILE            = DoxygenLayout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -873,7 +874,18 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = include/cyclone/ck_ht_hash.h include/cyclone/runtime-main.h .git docs examples scheme scripts srfi tests *.md cyclone.c generate-c.c icyc.c
+EXCLUDE                = include/cyclone/ck_ht_hash.h \
+                         include/cyclone/runtime-main.h \
+                         .git \
+                         docs \
+                         examples \
+                         scheme \
+                         scripts \
+                         srfi \
+                         tests \
+                         cyclone.c \
+                         generate-c.c \
+                         icyc.c
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -1927,7 +1939,7 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = YES
+GENERATE_XML           = NO
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

include/cyclone/types.h

@@ -82,7 +82,7 @@ typedef unsigned char tag_type;
 /**
  * \defgroup gc Garbage Collector
  *
- * All of the code related to the garbage collector.
+ * @brief All of the code related to the garbage collector.
  *
  * When using the FFI there is normally no need to call 
  * into this code unless something is specifically mentioned
@@ -362,7 +362,15 @@ void clear_mutations(void *data);
 /**@}*/
 
 /**
- * \defgroup immediates Data Types - Immediate Objects
+ * \defgroup datatypes Data Types
+ * @brief All of the Scheme data types provided by Cyclone.
+ */
+/**@{*/
+
+/**
+ * \defgroup immediates Immediate Objects
+ *  
+ *  @brief Objects that do not require memory allocation.
  *
  *  Immediate objects (also known as value types) are stored directly within
  *  the bits that would otherwise be a pointer to an object type. Since
@@ -433,7 +441,8 @@ void clear_mutations(void *data);
 /**@}*/
 
 /**
- * \defgroup objects Data Types - Objects
+ * \defgroup objects Objects
+ * @brief Definitions and code for memory-allocated objects.
  *
  * Most Scheme data types are defined as object types.
  *
@@ -954,6 +963,7 @@ typedef union {
   bignum_type bignum_t;
 } common_type;
 
+/**@}*/
 /**@}*/
 
 /* Utility functions */