Revision: 4772 http://geany.svn.sourceforge.net/geany/?rev=4772&view=rev Author: ntrel Date: 2010-03-18 13:13:11 +0000 (Thu, 18 Mar 2010)
Log Message: ----------- Improve API docs contents page by listing all commonly-used files. Fix 'Date' appearing twice on the date line. Don't generate API docs for prefs.h, toolbar.h (unused). Move some '@file' doc-comments to the .c file.
Modified Paths: -------------- trunk/ChangeLog trunk/doc/plugins.dox trunk/src/pluginutils.c trunk/src/prefs.c trunk/src/prefs.h trunk/src/toolbar.c trunk/src/toolbar.h
Modified: trunk/ChangeLog =================================================================== --- trunk/ChangeLog 2010-03-18 12:35:16 UTC (rev 4771) +++ trunk/ChangeLog 2010-03-18 13:13:11 UTC (rev 4772) @@ -3,6 +3,12 @@ * data/filetypes.common: Set default for wrapped lines to show marker at end of line only (more expected and doesn't change line alignment - closes #2972386). + * src/toolbar.c, src/toolbar.h, src/prefs.c, src/prefs.h, + src/pluginutils.c, doc/plugins.dox: + Improve API docs contents page by listing all commonly-used files. + Fix 'Date' appearing twice on the date line. + Don't generate API docs for prefs.h, toolbar.h (unused). + Move some '@file' doc-comments to the .c file.
2010-03-17 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
Modified: trunk/doc/plugins.dox =================================================================== --- trunk/doc/plugins.dox 2010-03-18 12:35:16 UTC (rev 4771) +++ trunk/doc/plugins.dox 2010-03-18 13:13:11 UTC (rev 4772) @@ -32,25 +32,38 @@ * @mainpage Geany Plugin API Documentation * * @author Enrico Tröger, Nick Treleaven, Frank Lanitz - * @date $Date$ + * $Date$ * * @section Intro * This is the Geany API documentation. It should be considered work in progress. * We will try to document as many functions and structs as possible. * - * To get started, see the @link howto Plugin Howto @endlink. + * @warning Do not use any symbol not in the documentation - it may change. * - * Other pages: + * @section pluginsupport Plugin Support + * - @link howto Plugin HowTo @endlink - get started * - @link pluginsymbols.c Plugin Symbols @endlink * - @link plugindata.h Main Datatypes and Macros @endlink * - @link signals Plugin Signals @endlink - * - @link pluginutils.c Plugin Utility Functions @endlink + * - @link pluginutils.h Plugin Utility Functions @endlink * - @link guidelines Plugin Writing Guidelines @endlink * - <b>plugins/demoplugin.c</b> - in Geany's source, bigger than the howto example - * - Header files for functions and types - see <b>Files</b> link at the top + * + * @section common Common API files + * - @link dialogs.h @endlink + * - @link document.h @endlink + * - @link editor.h @endlink + * - @link filetypes.h @endlink + * - @link msgwindow.h @endlink + * - @link project.h @endlink + * - @link sciwrappers.h Scintilla Wrapper Functions @endlink + * - @link utils.h General Utility Functions @endlink + * - @link ui_utils.h Widget Utility Functions @endlink + + * @section More + * - All API functions and types - see <b>Files</b> link at the top * - Deprecated symbols - see <b>Related Pages</b> link at the top * - * @warning Do not use any symbol not in the documentation - it may change. * @note See the HACKING file for information about developing the plugin API and * other useful notes. */ @@ -376,7 +389,7 @@ * the plugin binary in @c ~/.config/geany/plugins/. * * - * @page howto Plugin Howto + * @page howto Plugin HowTo * * @section intro Introduction *
Modified: trunk/src/pluginutils.c =================================================================== --- trunk/src/pluginutils.c 2010-03-18 12:35:16 UTC (rev 4771) +++ trunk/src/pluginutils.c 2010-03-18 13:13:11 UTC (rev 4772) @@ -22,7 +22,7 @@ * $Id$ */
-/** @file pluginutils.c +/** @file pluginutils.h * Plugin utility functions. * These functions all take the @ref geany_plugin symbol as their first argument. */
Modified: trunk/src/prefs.c =================================================================== --- trunk/src/prefs.c 2010-03-18 12:35:16 UTC (rev 4771) +++ trunk/src/prefs.c 2010-03-18 13:13:11 UTC (rev 4772) @@ -22,6 +22,11 @@ */
/* + * @file prefs.h + * Preferences dialog. + */ + +/* * Preferences dialog support functions. * New prefs should use Stash code in keyfile.c - init_pref_groups(). */
Modified: trunk/src/prefs.h =================================================================== --- trunk/src/prefs.h 2010-03-18 12:35:16 UTC (rev 4771) +++ trunk/src/prefs.h 2010-03-18 13:13:11 UTC (rev 4772) @@ -20,12 +20,6 @@ * */
-/** - * @file prefs.h - * Preferences dialog. - **/ - - #ifndef GEANY_PREFS_H #define GEANY_PREFS_H 1
Modified: trunk/src/toolbar.c =================================================================== --- trunk/src/toolbar.c 2010-03-18 12:35:16 UTC (rev 4771) +++ trunk/src/toolbar.c 2010-03-18 13:13:11 UTC (rev 4772) @@ -21,10 +21,11 @@ * $Id$ */
- -/** @file toolbar.c - * Utility functions to create the toolbar. +/** + * @file toolbar.h + * Toolbar (prefs). */ +/* Utility functions to create the toolbar */
#include "geany.h" #include "support.h"
Modified: trunk/src/toolbar.h =================================================================== --- trunk/src/toolbar.h 2010-03-18 12:35:16 UTC (rev 4771) +++ trunk/src/toolbar.h 2010-03-18 13:13:11 UTC (rev 4772) @@ -21,12 +21,6 @@ * $Id$ */
-/** - * @file toolbar.h - * Toolbar (prefs). - **/ - - #ifndef GEANY_TOOLBAR_H #define GEANY_TOOLBAR_H
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.