[geany/geany] 72482e: docs: Fix references to renamed symbols

Colomban Wendling git-noreply at xxxxx
Thu Jun 23 21:30:39 UTC 2016


Branch:      refs/heads/master
Author:      Colomban Wendling <ban at herbesfolles.org>
Committer:   Colomban Wendling <ban at herbesfolles.org>
Date:        Thu, 23 Jun 2016 21:30:39 UTC
Commit:      72482e8e328d9a39c5d9a9c997ff0b22200d802d
             https://github.com/geany/geany/commit/72482e8e328d9a39c5d9a9c997ff0b22200d802d

Log Message:
-----------
docs: Fix references to renamed symbols


Modified Paths:
--------------
    src/document.c
    src/document.h

Modified: src/document.c
4 lines changed, 2 insertions(+), 2 deletions(-)
===================================================================
@@ -3273,9 +3273,9 @@ const GdkColor *document_get_status_color(GeanyDocument *doc)
 }
 
 
-/** Accessor function for @ref documents_array items.
+/** Accessor function for @ref GeanyData::documents_array items.
  * @warning Always check the returned document is valid (@c doc->is_valid).
- * @param idx @c documents_array index.
+ * @param idx @c GeanyData::documents_array index.
  * @return @transfer{none} @nullable The document, or @c NULL if @a idx is out of range.
  *
  *  @since 0.16


Modified: src/document.h
6 lines changed, 3 insertions(+), 3 deletions(-)
===================================================================
@@ -75,7 +75,7 @@ GeanyFilePrefs;
  **/
 typedef struct GeanyDocument
 {
-	/** Flag used to check if this document is valid when iterating @ref documents_array. */
+	/** Flag used to check if this document is valid when iterating @ref GeanyData::documents_array. */
 	gboolean		 is_valid;
 	gint			 index;		/**< Index in the documents array. */
 	/** Whether this document supports source code symbols(tags) to show in the sidebar. */
@@ -118,7 +118,7 @@ typedef struct GeanyDocument
 }
 GeanyDocument;
 
-/** Wraps @ref documents_array so it can be used with C array syntax.
+/** Wraps @ref GeanyData::documents_array so it can be used with C array syntax.
  * @warning Always check the returned document is valid (@c doc->is_valid).
  *
  * Example: @code GeanyDocument *doc = documents[i]; @endcode
@@ -135,7 +135,7 @@ GeanyDocument;
 
 /** Iterates all valid document indexes.
  * Use like a @c for statement.
- * @param i @c guint index for @ref documents_array.
+ * @param i @c guint index for @ref GeanyData::documents_array.
  *
  * Example:
  * @code



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).


More information about the Commits mailing list