Closes #964
You can view, comment on, or merge this pull request online at:
https://github.com/geany/geany/pull/966
-- Commit Summary --
* Remove `documents_array` global from plugin API * Move some documentation to show up in API docs.
-- File Changes --
M src/document.c (18) M src/document.h (3) M src/filetypes.c (14) M src/plugindata.h (34)
-- Patch Links --
https://github.com/geany/geany/pull/966.patch https://github.com/geany/geany/pull/966.diff
--- Reply to this email directly or view it on GitHub: https://github.com/geany/geany/pull/966
I should note that I only tested that Geany still builds.
--- Reply to this email directly or view it on GitHub: https://github.com/geany/geany/pull/966#issuecomment-196530511
Does G-P build against this Geany?
--- Reply to this email directly or view it on GitHub: https://github.com/geany/geany/pull/966#issuecomment-196557238
Dunno see above comment.
I suspect they will though. This can only break plugins which never worked on Windows and haven't worked on Linux/etc for a couple of releases. What's more, with GP build system, these plugin's wouldn't have even linked since it doesn't allow undefined symbols IIRC.
--- Reply to this email directly or view it on GitHub: https://github.com/geany/geany/pull/966#issuecomment-196569404
Sounds fair.
--- Reply to this email directly or view it on GitHub: https://github.com/geany/geany/pull/966#issuecomment-196572167
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
All GP seem to build fine indeed.
--- 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-198809888
Otherwise, looks good.
--- 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-198809936
Merged #966.
--- 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#event-702542694
github-comments@lists.geany.org