[Github-comments] [geany] Privatize global and publicize docs (#966)

[Colomban Wendling]

This introduces some Doxygen warnings because references broke.  This fixes them:
```diff
diff --git a/src/document.c b/src/document.c
index 902c2d4..f3de37c 100644
--- a/src/document.c
+++ b/src/document.c
@@ -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
diff --git a/src/document.h b/src/document.h
index 16316f4..9ecf3fb 100644
--- a/src/document.h
+++ b/src/document.h
@@ -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
```

---
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/geany/geany/pull/966#issuecomment-198807996
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.geany.org/pipermail/github-comments/attachments/20160319/96c50b94/attachment.html>