HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add dox for GeanyApp, GeanyProject.

Browse Source 
Move GeanyProject typedef to project.h, as it is rarely used without
including project.h.


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2811 ea778897-0a13-0410-b9d1-a72fbfd435f5
This commit is contained in:
Nick Treleaven 2008-07-24 14:37:36 +00:00
parent 1580203f8a
commit 553e5c63d9
4 changed files with 29 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -9,6 +9,10 @@
Add dox for all UIUtilsFuncs. Add dox for all UIUtilsFuncs.
* src/plugindata.h, src/document.c: * src/plugindata.h, src/document.c:
Rename document_new_file() argument to utf8_filename. 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> 2008-07-23 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>

15
src/geany.h
View File

@ -54,21 +54,24 @@
#define GEANY_WINDOW_DEFAULT_HEIGHT 600 #define GEANY_WINDOW_DEFAULT_HEIGHT 600
/* useful forward declarations */ /* Common forward declarations */
typedef struct GeanyDocument GeanyDocument; typedef struct GeanyDocument GeanyDocument;
typedef struct GeanyFiletype GeanyFiletype; typedef struct GeanyFiletype GeanyFiletype;
typedef struct GeanyProject GeanyProject;
/* Important commonly-used items. */ /** Important application fields. */
typedef struct GeanyApp 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 *configdir;
gchar *datadir; gchar *datadir;
gchar *docdir; gchar *docdir;
const TMWorkspace *tm_workspace; const TMWorkspace *tm_workspace; /**< TagManager workspace/session tags. */
GeanyProject *project; /* currently active project or NULL if none is open */ struct GeanyProject *project; /**< Currently active project or @c NULL if none is open. */
} }
GeanyApp; GeanyApp;

2
src/project.c
View File

@ -21,7 +21,7 @@
* $Id$ * $Id$
*/ */
/* /** @file project.h
* Project Management. * Project Management.
*/ */

33
src/project.h
View File

@ -28,27 +28,24 @@
#define GEANY_PROJECT_EXT "geany" #define GEANY_PROJECT_EXT "geany"
/* structure for representing a project. */ /** Structure for representing a project. */
struct GeanyProject typedef struct GeanyProject
{ {
gchar *name; /* the name of the project */ gchar *name; /**< The name of the project. */
gchar *description; /* short description of the project */ gchar *description; /**< Short description of the project. */
gchar *file_name; /**< Where the project file is stored (in UTF-8). */
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). */
gchar *base_path; /* base path of the project directory (in UTF-8, maybe relative) */ /** Identifier whether it is a pure Geany project or modified/extended
gchar *run_cmd; /* project run command (in UTF-8) */ * by a plugin. */
/* ... */ /* fields for build process(run arguments and so on) should be added */ gint type;
gchar **file_patterns; /**< Array of filename extension patterns. */
gint type; /* identifier whether it is a pure Geany project or modified/extended */
/* by a plugin */
gchar **file_patterns; /* array of filename extension patterns */
gboolean make_in_base_path; gboolean make_in_base_path;
}; }
GeanyProject;
typedef struct
typedef struct ProjectPrefs
{ {
gchar *session_file; gchar *session_file;
gboolean project_session; gboolean project_session;