Updated doxygen documentation, revised copyright stuff
diff --git a/contiki/ek/dsc.h b/contiki/ek/dsc.h
index a7d19e9..ca08c9f 100644
--- a/contiki/ek/dsc.h
+++ b/contiki/ek/dsc.h
@@ -1,3 +1,20 @@
+/**
+ * \file
+ * Declaration of the DSC program description structure.
+ * \author Adam Dunkels <adam@dunkels.com>
+ *
+ * The Contiki DSC structure is used for describing programs. It
+ * includes a string describing the program, the name of the program
+ * file on disk (or a pointer to the programs initialization function
+ * for systems without disk support), a bitmap icon and a text version
+ * of the same icon.
+ *
+ * The DSC is saved into a file which can be loaded by programs such
+ * as the "Directory" application which reads all DSC files on disk
+ * and presents the icons and descriptions in a window.
+ *
+ */
+
/*
* Copyright (c) 2003, Adam Dunkels.
* All rights reserved.
@@ -29,7 +46,7 @@
*
* This file is part of the Contiki desktop environment
*
- * $Id: dsc.h,v 1.3 2003/08/24 22:41:31 adamdunkels Exp $
+ * $Id: dsc.h,v 1.4 2003/09/02 21:47:28 adamdunkels Exp $
*
*/
#ifndef __DSC_H__
@@ -37,26 +54,51 @@
#include "ctk.h"
-/* The dsc struct is used for describing a Contiki program. It
- includes a short textual description of the program, either the
- name of the program on disk, or a pointer to the init() function,
- and an icon for the program. */
+/**
+ * The DSC program description structure.
+ *
+ * The DSC structure is used for describing a Contiki program. It
+ * includes a short textual description of the program, either the
+ * name of the program on disk, or a pointer to the init() function,
+ * and an icon for the program.
+ */
struct dsc {
- char *description;
+ char *description; /**< A text string containing a one-line
+ description of the program */
#if WITH_LOADER_ARCH
- char *prgname;
+ char *prgname; /**< The name of the program on disk. */
#else /* WITH_LOADER_ARCH */
- void (*init)(char *arg);
+ void (*init)(char *arg); /**< A pointer to the initialization
+ function of the program .*/
#endif /* WITH_LOADER_ARCH */
- struct ctk_icon *icon;
-
+ struct ctk_icon *icon; /**< A pointer to the ctk_icon structure for
+ the DSC. */
+
#if WITH_LOADER_ARCH
- void *loadaddr;
+ void *loadaddr; /**< The loading address of the DSC. Used by
+ the LOADER_UNLOAD() function when
+ deallocating the memory allocated for the
+ DSC when loading it. */
#endif /* WITH_LOADER_ARCH */
};
+/**
+ * Intantiating macro for the DSC structure.
+ *
+ * \param dscname The name of the C variable which is to contain the
+ * DSC.
+ *
+ * \param description A one-line text describing the program.
+ *
+ * \param prgname The name of the program on disk.
+ *
+ * \param initfunc A pointer to the initialization function of the
+ * program.
+ *
+ * \param icon A pointer to the CTK icon.
+ */
#if WITH_LOADER_ARCH
#define DSC(dscname, description, prgname, initfunc, icon) \
const struct dsc dscname = {description, prgname, icon}