[geany/geany] 6d6dd7: Fix doxygen warnings

[Jiří Techet]

Branch:      refs/heads/master
Author:      Jiří Techet <techet at gmail.com>
Committer:   Jiří Techet <techet at gmail.com>
Date:        Sun, 12 Oct 2014 21:33:51 UTC
Commit:      6d6dd7444b57b41cf657f61f6c514afead12e598
             https://github.com/geany/geany/commit/6d6dd7444b57b41cf657f61f6c514afead12e598

Log Message:
-----------
Fix doxygen warnings

Make documents_array public and accessible by doxygen and describe all
parameters of tm_source_file_new().


Modified Paths:
--------------
    src/document.h
    tagmanager/src/tm_source_file.h

Modified: src/document.h
3 lines changed, 1 insertions(+), 2 deletions(-)
===================================================================
@@ -116,6 +116,7 @@ typedef struct GeanyDocument
 }
 GeanyDocument;
 
+extern GPtrArray *documents_array;
 
 /** Wraps @ref documents_array so it can be used with C array syntax.
  * @warning Always check the returned document is valid (@c doc->is_valid).
@@ -227,8 +228,6 @@ GeanyDocument *document_find_by_id(guint id);
 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_CR
 #endif
 
-extern GPtrArray *documents_array;
-
 extern GeanyFilePrefs file_prefs;
 
 


Modified: tagmanager/src/tm_source_file.h
7 lines changed, 6 insertions(+), 1 deletions(-)
===================================================================
@@ -44,7 +44,12 @@ typedef struct
 	gboolean inactive; /*!< Whether this file should be scanned for tags */
 } TMSourceFile;
 
-/*! Initializes a TMSourceFile structure and returns a pointer to it. */
+/*! Initializes a TMSourceFile structure and returns a pointer to it. 
+ * \param file_name The file name.
+ * \param update Update the tag array of the file.
+ * \param name Name of the used programming language, NULL for autodetection.
+ * \return The created TMSourceFile object.
+ * */
 TMWorkObject *tm_source_file_new(const char *file_name, gboolean update, const char *name);
 
 /*! Updates the source file by reparsing if the modification time is greater



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