First doxygen wave.

Doxyfile

@@ -996,7 +996,7 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator 
 # instead of the = operator.
 
-PREDEFINED             = 
+PREDEFINED             = DOXYGEN_SKIP
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
 # this tag can be used to specify a list of macro names that should be expanded. 

boxedit.c

@@ -17,6 +17,11 @@
  *
  */
 
+/**
+ * @file boxedit.c
+ * @brief Gtk based box editor
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

char.c

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file char.c
+ * @ingroup scumm
+ * @brief SCUMM charset generator
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

code.c

@@ -16,6 +16,13 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
+
+/**
+ * @file code.c
+ * @ingroup scumm
+ * @brief SCUMM image encoders
+ */
+
 #include "config.h"
 
 #include <inttypes.h>

cost_lexer.c

@@ -17,6 +17,12 @@
  *
  */
 
+/** 
+ * @file cost_lexer.c
+ * @ingroup lex
+ * @brief Costume lexer.
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

cost_parse.y

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file cost_parse.y
+ * @ingroup scumm
+ * @brief Costume compiler
+ */
+
 %{
 
 #include "config.h"

costview.c

@@ -16,6 +16,12 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
+
+/**
+ * @file costview.c
+ * @brief Gtk based costume viewer
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

decode.c

@@ -16,6 +16,13 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
+
+/**
+ * @file decode.c
+ * @ingroup scumm
+ * @brief SCUMM image decoders
+ */
+
 #include "config.h"
 
 #include <inttypes.h>

imgremap.c

@@ -16,6 +16,12 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
+
+/**
+ * @file imgremap.c
+ * @brief Tool to swap colors in an image
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

imgsplit.c

@@ -16,6 +16,12 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
+
+/**
+ * @file imgsplit.c
+ * @brief Tool to split an image
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

palcat.c

@@ -16,6 +16,12 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
+
+/**
+ * @file palcat.c
+ * @brief Tool to concatenate image palette
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

raw2voc.c

@@ -16,6 +16,12 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
+
+/**
+ * @file raw2voc.c
+ * @brief Tool to create voc files from raw PCM data
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

rd.c

@@ -16,6 +16,12 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
+
+/**
+ * @file rd.c
+ * @brief Experiment playground, currently dump SCUMM files.
+ */
+
 #include "config.h"
 
 #include <sys/types.h>

read.c

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file read.c
+ * @ingroup scumm
+ * @brief Read SCUMM data. Mostly obsolete.
+ */
+
 #include "config.h"
 
 // We can probably kick some since the testing code left us.

scc.h

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file scc.h
+ * @ingroup scumm
+ * @brief Read/write SCUMM data. Mostly obsolete.
+ */
+
 #define OF_STATE_SHL 4
 #define OF_OWNER_MASK 0x0F
 

scc_char.c

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file scc_char.c
+ * @ingroup scumm
+ * @brief SCUMM charset parser
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

scc_char.h

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file scc_char.h
+ * @ingroup scumm
+ * @brief SCUMM charset parser
+ */
+
 typedef struct scc_char_st {
   uint8_t w,h;
   int8_t  x,y;

scc_code.c

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file scc_code.c
+ * @ingroup scc
+ * @brief SCUMM code generator
+ */
+
 #include "config.h"
 
 #include <stdlib.h>

scc_code.h

@@ -17,24 +17,63 @@
  *
  */
 
-// A little stack for the loop, this is needed
-// by the parser to check the branch instruction validity.
+/**
+ * @file scc_code.h
+ * @ingroup scc
+ * @brief SCUMM code generator
+ */
+
+/// @name Loop Stack
+/// A little stack for the loops, this is needed
+/// by the parser to check the branch instruction validity.
+//@{
+
+/// @brief       Add a loop entry to the stack.
+/// @param type  Type of the corresponding instruction
+/// @param sym   Name of the loop or NULL
 void scc_loop_push(int type, char* sym);
 
+/// @brief  Pop the current loop
+/// @return The poped loop
 scc_loop_t* scc_loop_pop(void);
 
+/// @brief       Get the loop referenced by a branching instruction.
+/// @param type  Type of the branching instruction
+/// @param sym   Name of the loop or NULL
+/// @return      The matching loop or NULL
 scc_loop_t* scc_loop_get(int type,char* sym);
 
+//@}
+
+/// @name Code blocks
+//@(
 
+/// Create a new code block
 scc_code_t* scc_code_new(int len);
 
+/// Destroy a code block
 void scc_code_free(scc_code_t* c);
 
+/// Destroy a code block list
 void scc_code_free_all(scc_code_t* c);
 
+//@}
+
+/// @name Scripts
+//@{
+
+/// @brief            Generate a script from a parse tree.
+/// @param ns         Namespace to use
+/// @param inst       The parse tree
+/// @param return_op  The op code to use for return
+/// @param close_scr  If true add a return at the end of the script.
 scc_script_t* scc_script_new(scc_ns_t* ns, scc_instruct_t* inst,
                              uint8_t return_op,char close_scr);
 
+/// Destroy a script
 void scc_script_free(scc_script_t* scr);
 
+/// Destroy a list of script
 void scc_script_list_free(scc_script_t* scr);
+
+//@}

scc_codec.h

@@ -17,12 +17,20 @@
  *
  */
 
+/// @defgroup scumm SCUMM data
+/**
+ * @file scc_codec.h
+ * @ingroup scumm
+ * @brief SCUMM image encoding/decoding
+ */
+
 // code.c
 
-// create an smap out from a bitmap. It simply try every codec for each
-// stripe and take the best one. Note that in the doot data at least some
-// room aren't using the best encoding.
-
+/// @brief Create a smap from a bitmap.
+///
+/// It simply try every codec for each stripe and take the best one.
+/// Note that in the doot data at least some room aren't using the
+/// best encoding.
 int scc_code_image(uint8_t* src, int src_stride,
                    int width,int height,int transparentColor,
                    uint8_t** smap_p);

scc_cost.c

@@ -16,6 +16,13 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  */
+
+/**
+ * @file scc_cost.c
+ * @ingroup scumm
+ * @brief SCUMM costume parser and decoder
+ */
+
 #include "config.h"
 
 #include <inttypes.h>

scc_cost.h

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file scc_cost.h
+ * @ingroup scumm
+ * @brief SCUMM costume parser and decoder
+ */
+
 typedef struct scc_cost_pic scc_cost_pic_t;
 struct scc_cost_pic {
   scc_cost_pic_t* next;

scc_fd.c

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file scc_fd.c
+ * @ingroup utils
+ * @brief Read/write file with XOR encryption
+ */
+
 #include "config.h"
 
 #include <stdio.h>

scc_fd.h

@@ -17,6 +17,13 @@
  *
  */
 
+/**
+ * @file scc_fd.h
+ * @ingroup utils
+ * @brief Read/write file with XOR encryption
+ */
+
+
 typedef struct scc_fd {
   int fd;
   uint8_t enckey;

scc_func.h

@@ -17,6 +17,12 @@
  *
  */
 
+/**
+ * @file scc_func.h
+ * @ingroup scc
+ * @brief ScummC builtin functions
+ */
+
 // A define for the various print function families
 
 #define PRINT(name,op) {                         \