SF.net SVN: geany:[2811] trunk

[ntrel at users.sourceforge.net]

Revision: 2811
          http://geany.svn.sourceforge.net/geany/?rev=2811&view=rev
Author:   ntrel
Date:     2008-07-24 14:37:36 +0000 (Thu, 24 Jul 2008)

Log Message:
-----------
Add dox for GeanyApp, GeanyProject.
Move GeanyProject typedef to project.h, as it is rarely used without
including project.h.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/src/geany.h
    trunk/src/project.c
    trunk/src/project.h

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2008-07-24 12:12:47 UTC (rev 2810)
+++ trunk/ChangeLog	2008-07-24 14:37:36 UTC (rev 2811)
@@ -9,6 +9,10 @@
    Add dox for all UIUtilsFuncs.
  * src/plugindata.h, src/document.c:
    Rename document_new_file() argument to utf8_filename.
+ * src/project.c, src/project.h, src/geany.h:
+   Add dox for GeanyApp, GeanyProject.
+   Move GeanyProject typedef to project.h, as it is rarely used without
+   including project.h.
 
 
 2008-07-23  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>

Modified: trunk/src/geany.h
===================================================================
--- trunk/src/geany.h	2008-07-24 12:12:47 UTC (rev 2810)
+++ trunk/src/geany.h	2008-07-24 14:37:36 UTC (rev 2811)
@@ -54,21 +54,24 @@
 #define GEANY_WINDOW_DEFAULT_HEIGHT		600
 
 
-/* useful forward declarations */
+/* Common forward declarations */
 typedef struct GeanyDocument GeanyDocument;
 typedef struct GeanyFiletype GeanyFiletype;
-typedef struct GeanyProject GeanyProject;
 
 
-/* Important commonly-used items. */
+/** Important application fields. */
 typedef struct GeanyApp
 {
-	gboolean			debug_mode;
+	gboolean			debug_mode;		/**< @c TRUE if debug messages should be printed. */
+	/** User configuration directory, usually @c ~/.geany.
+	 * @note Plugin configuration files should be saved as:
+	 * @code g_build_path(G_DIR_SEPARATOR_S, geany->app->configdir, "plugins", "pluginname",
+	 * 	"file.conf"); @endcode */
 	gchar				*configdir;
 	gchar				*datadir;
 	gchar				*docdir;
-	const TMWorkspace	*tm_workspace;
-	GeanyProject		*project;			/* currently active project or NULL if none is open */
+	const TMWorkspace	*tm_workspace;	/**< TagManager workspace/session tags. */
+	struct GeanyProject	*project;		/**< Currently active project or @c NULL if none is open. */
 }
 GeanyApp;
 

Modified: trunk/src/project.c
===================================================================
--- trunk/src/project.c	2008-07-24 12:12:47 UTC (rev 2810)
+++ trunk/src/project.c	2008-07-24 14:37:36 UTC (rev 2811)
@@ -21,7 +21,7 @@
  * $Id$
  */
 
-/*
+/** @file project.h
  * Project Management.
  */
 

Modified: trunk/src/project.h
===================================================================
--- trunk/src/project.h	2008-07-24 12:12:47 UTC (rev 2810)
+++ trunk/src/project.h	2008-07-24 14:37:36 UTC (rev 2811)
@@ -28,27 +28,24 @@
 #define GEANY_PROJECT_EXT				"geany"
 
 
-/* structure for representing a project. */
-struct GeanyProject
+/** Structure for representing a project. */
+typedef struct GeanyProject
 {
-	gchar *name; 			/* the name of the project */
-	gchar *description; 	/* short description of the project */
-
-	gchar *file_name; 		/* where the project file is stored (in UTF-8) */
-
-	gchar *base_path;		/* base path of the project directory (in UTF-8, maybe relative) */
-	gchar *run_cmd; 		/* project run command (in UTF-8) */
-	/* ...	*/				/* fields for build process(run arguments and so on) should be added */
-
-	gint type;				/* identifier whether it is a pure Geany project or modified/extended */
-							/* by a plugin */
-
-	gchar **file_patterns;	/* array of filename extension patterns */
-
+	gchar *name; 			/**< The name of the project. */
+	gchar *description; 	/**< Short description of the project. */
+	gchar *file_name; 		/**< Where the project file is stored (in UTF-8). */
+	gchar *base_path;		/**< Base path of the project directory (in UTF-8, maybe relative). */
+	gchar *run_cmd; 		/**< Project run command (in UTF-8). */
+	/** Identifier whether it is a pure Geany project or modified/extended
+	 * by a plugin. */
+	gint type;
+	gchar **file_patterns;	/**< Array of filename extension patterns. */
 	gboolean make_in_base_path;
-};
+}
+GeanyProject;
 
-typedef struct
+
+typedef struct ProjectPrefs
 {
 	gchar *session_file;
 	gboolean project_session;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.