Revision: 4063 http://geany.svn.sourceforge.net/geany/?rev=4063&view=rev Author: eht16 Date: 2009-08-09 20:31:03 +0000 (Sun, 09 Aug 2009)

Log Message: ----------- Small corrections to some API docs.

Modified Paths: -------------- trunk/ChangeLog trunk/doc/plugins.dox trunk/src/document.c trunk/src/document.h trunk/src/documentprivate.h

Modified: trunk/ChangeLog =================================================================== --- trunk/ChangeLog 2009-08-09 11:17:00 UTC (rev 4062) +++ trunk/ChangeLog 2009-08-09 20:31:03 UTC (rev 4063) @@ -5,6 +5,9 @@ * src/keybindings.c: Switching notebook tabs now works for the currently used notebook widget instead of always using the documents notebook. + * src/document.c, src/document.h, src/documentprivate.h, + doc/plugins.dox: + Small corrections to some API docs.

2009-08-02 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>

Modified: trunk/doc/plugins.dox =================================================================== --- trunk/doc/plugins.dox 2009-08-09 11:17:00 UTC (rev 4062) +++ trunk/doc/plugins.dox 2009-08-09 20:31:03 UTC (rev 4063) @@ -37,7 +37,7 @@ * @section Intro * This is the Geany API documentation. It is far from being complete and should be * considered as a work in progress. - * We will try to %document as many functions and structs as possible. + * We will try to document as many functions and structs as possible. * * To get started, see the @link howto Plugin Howto @endlink. * @@ -89,7 +89,7 @@ * void user_function(GObject *obj, GeanyDocument *doc, gpointer user_data); * @endsignalproto * @signaldesc - * Sent when a new %document is created. + * Sent when a new document is created. * * You need to include "document.h" for the declaration of GeanyDocument. * @@ -103,7 +103,7 @@ * void user_function(GObject *obj, GeanyDocument *doc, gpointer user_data); * @endsignalproto * @signaldesc - * Sent when a new %document is opened. + * Sent when a new document is opened. * * You need to include "document.h" for the declaration of GeanyDocument. * @@ -117,7 +117,7 @@ * void user_function(GObject *obj, GeanyDocument *doc, gpointer user_data); * @endsignalproto * @signaldesc - * Sent when a new %document is saved. + * Sent when a new document is saved. * * You need to include "document.h" for the declaration of GeanyDocument. * @@ -333,7 +333,7 @@ * @section intro Introduction * * Since Geany 0.12 there is a plugin interface to extend Geany's functionality and - * add new features. This %document gives a brief overview about how to add new + * add new features. This document gives a brief overview about how to add new * plugins by writing a simple "Hello World" plugin in C. * *

Modified: trunk/src/document.c =================================================================== --- trunk/src/document.c 2009-08-09 11:17:00 UTC (rev 4062) +++ trunk/src/document.c 2009-08-09 20:31:03 UTC (rev 4063) @@ -254,9 +254,9 @@

/** - * Find and retrieve the current %document. + * Find and retrieve the current document. * - * @return A pointer to the current %document or @c NULL if there are no opened documents. + * @return A pointer to the current document or @c NULL if there are no opened documents. **/ GeanyDocument *document_get_current(void) { @@ -750,12 +750,12 @@

/** - * Open a %document specified by @a locale_filename. + * Open a document specified by @a locale_filename. * After all, the "document-open" signal is emitted for plugins. * - * @param locale_filename The filename of the %document to load, in locale encoding. - * @param readonly Whether to open the %document in read-only mode. - * @param ft The %filetype for the %document or @c NULL to auto-detect the %filetype. + * @param locale_filename The filename of the document to load, in locale encoding. + * @param readonly Whether to open the document in read-only mode. + * @param ft The filetype for the document or @c NULL to auto-detect the filetype. * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding. * * @return The document opened or @c NULL. @@ -1365,8 +1365,8 @@ * Internally, document_open_file() is called for every list item. * * @param filenames A list of filenames to load, in locale encoding. - * @param readonly Whether to open the %document in read-only mode. - * @param ft The %filetype for the %document or @c NULL to auto-detect the %filetype. + * @param readonly Whether to open the document in read-only mode. + * @param ft The filetype for the document or @c NULL to auto-detect the filetype. * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding. **/ void document_open_files(const GSList *filenames, gboolean readonly, GeanyFiletype *ft, @@ -1387,7 +1387,7 @@ * @param doc The document to reload. * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding. * - * @return @c TRUE if the %document was actually reloaded or @c FALSE otherwise. + * @return @c TRUE if the document was actually reloaded or @c FALSE otherwise. **/ gboolean document_reload_file(GeanyDocument *doc, const gchar *forced_enc) { @@ -1689,7 +1689,7 @@ * * If the file is not modified, this functions does nothing unless force is set to @c TRUE. * - * @param doc The %document to save. + * @param doc The document to save. * @param force Whether to save the file even if it is not modified (e.g. for Save As). * * @return @c TRUE if the file was saved or @c FALSE if the file could not or should not be saved. @@ -2466,12 +2466,12 @@

/** - * Sets the encoding of a %document. + * Sets the encoding of a document. * This function only set the encoding of the %document, it does not any conversions. The new * encoding is used when e.g. saving the file. * - * @param doc The %document to use. - * @param new_encoding The encoding to be set for the %document. + * @param doc The document to use. + * @param new_encoding The encoding to be set for the document. **/ void document_set_encoding(GeanyDocument *doc, const gchar *new_encoding) {

Modified: trunk/src/document.h =================================================================== --- trunk/src/document.h 2009-08-09 11:17:00 UTC (rev 4062) +++ trunk/src/document.h 2009-08-09 20:31:03 UTC (rev 4063) @@ -71,7 +71,7 @@ /** General flag to represent this document is active and all properties are set correctly. */ gboolean is_valid; gint index; /**< Index in the documents array. */ - /** Whether this %document support source code symbols(tags) to show in the sidebar. */ + /** Whether this document supports source code symbols(tags) to show in the sidebar. */ gboolean has_tags; /** The UTF-8 encoded file name. * Be careful; glibc and GLib file functions expect the locale representation of the @@ -79,20 +79,20 @@ * For conversion into locale encoding, you can use @ref utils_get_locale_from_utf8(). * @see real_path. */ gchar *file_name; - /** The encoding of the %document, must be a valid string representation of an encoding, can + /** The encoding of the document, must be a valid string representation of an encoding, can * be retrieved with @ref encodings_get_charset_from_index. */ gchar *encoding; - /** Internally used flag to indicate whether the file of this %document has a byte-order-mark. */ + /** Internally used flag to indicate whether the file of this document has a byte-order-mark. */ gboolean has_bom; struct GeanyEditor *editor; /**< The editor associated with the document. */ - /** The filetype for this %document, it's only a reference to one of the elements of the global + /** The filetype for this document, it's only a reference to one of the elements of the global * filetypes array. */ GeanyFiletype *file_type; - /** TMWorkObject object for this %document, or @c NULL. */ + /** TMWorkObject object for this document, or @c NULL. */ TMWorkObject *tm_file; - /** Whether this %document is read-only. */ + /** Whether this document is read-only. */ gboolean readonly; - /** Whether this %document has been changed since it was last saved. */ + /** Whether this document has been changed since it was last saved. */ gboolean changed; /** The link-dereferenced, locale-encoded file name. * If non-NULL, this indicates the file once existed on disk (not just as an @@ -133,8 +133,8 @@

/** * DOC_FILENAME returns the filename of the document passed or - * GEANY_STRING_UNTITLED (e.g. _("untitled")) if the %document's filename was not yet set. - * This macro never returns NULL. + * GEANY_STRING_UNTITLED (e.g. _("untitled")) if the document's filename was not yet set. + * This macro never returns @c NULL. **/ #define DOC_FILENAME(doc) \ (G_LIKELY(doc->file_name != NULL) ? (doc->file_name) : GEANY_STRING_UNTITLED)

Modified: trunk/src/documentprivate.h =================================================================== --- trunk/src/documentprivate.h 2009-08-09 11:17:00 UTC (rev 4062) +++ trunk/src/documentprivate.h 2009-08-09 20:31:03 UTC (rev 4063) @@ -59,11 +59,11 @@ { /* GtkLabel shown in the notebook header. */ GtkWidget *tab_label; - /* GtkTreeView object for this %document within the Symbols treeview of the sidebar. */ + /* GtkTreeView object for this document within the Symbols treeview of the sidebar. */ GtkWidget *tag_tree; - /* GtkTreeStore object for this %document within the Symbols treeview of the sidebar. */ + /* GtkTreeStore object for this document within the Symbols treeview of the sidebar. */ GtkTreeStore *tag_store; - /* Iter for this %document within the Open Files treeview of the sidebar. */ + /* Iter for this document within the Open Files treeview of the sidebar. */ GtkTreeIter iter; /* Used by the Undo/Redo management code. */ GTrashStack *undo_actions;

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