Branch: refs/heads/master Author: Matthew Brush mbrush@codebrainz.ca Committer: Matthew Brush mbrush@codebrainz.ca Date: Mon, 14 Mar 2016 21:25:35 UTC Commit: d4aab06f9ba8bc0534303ce4b59b837a687be848 https://github.com/geany/geany/commit/d4aab06f9ba8bc0534303ce4b59b837a687be8...
Log Message: ----------- Move some documentation to show up in API docs.
The Doxygen comments were on the non-public global filetypes_array and filetypes_by_title variables instead of the GeanyData members which are exposed to the plugin API and reference manual.
Modified Paths: -------------- src/filetypes.c src/plugindata.h
Modified: src/filetypes.c 14 lines changed, 0 insertions(+), 14 deletions(-) =================================================================== @@ -55,22 +55,8 @@
#define GEANY_FILETYPE_SEARCH_LINES 2 /* lines of file to search for filetype */
-/** Dynamic array of filetype pointers - * - * List the list is dynamically expanded for custom filetypes filetypes so don't expect - * the list of known filetypes to be a constant. - * - * @elementtype{GeanyFiletype} - * */ GPtrArray *filetypes_array = NULL; - static GHashTable *filetypes_hash = NULL; /* Hash of filetype pointers based on name keys */ - -/** List of filetype pointers sorted by name, but with @c filetypes_index(GEANY_FILETYPES_NONE) - * first, as this is usually treated specially. - * The list does not change (after filetypes have been initialized), so you can use - * @code g_slist_nth_data(filetypes_by_title, n) @endcode and expect the same result at different times. - * @see filetypes_get_sorted_by_name(). */ GSList *filetypes_by_title = NULL;
Modified: src/plugindata.h 16 lines changed, 14 insertions(+), 2 deletions(-) =================================================================== @@ -188,7 +188,14 @@ typedef struct GeanyData * * @see documents. */ GPtrArray *documents_array; - GPtrArray *filetypes_array; /**< Dynamic array of GeanyFiletype pointers. @elementtype{GeanyFiletype} */ + /** Dynamic array of filetype pointers + * + * List the list is dynamically expanded for custom filetypes filetypes so don't expect + * the list of known filetypes to be a constant. + * + * @elementtype{GeanyFiletype} + */ + GPtrArray *filetypes_array; struct GeanyPrefs *prefs; /**< General settings */ struct GeanyInterfacePrefs *interface_prefs; /**< Interface settings */ struct GeanyToolbarPrefs *toolbar_prefs; /**< Toolbar settings */ @@ -198,7 +205,12 @@ typedef struct GeanyData struct GeanyToolPrefs *tool_prefs; /**< Tool settings */ struct GeanyTemplatePrefs *template_prefs; /**< Template settings */ gpointer *_compat; /* Remove field on next ABI break (abi-todo) */ - GSList *filetypes_by_title; /**< See filetypes.h#filetypes_by_title. */ + /** List of filetype pointers sorted by name, but with @c filetypes_index(GEANY_FILETYPES_NONE) + * first, as this is usually treated specially. + * The list does not change (after filetypes have been initialized), so you can use + * @code g_slist_nth_data(filetypes_by_title, n) @endcode and expect the same result at different times. + * @see filetypes_get_sorted_by_name(). */ + GSList *filetypes_by_title; } GeanyData;
-------------- This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).