From 6d6dd7444b57b41cf657f61f6c514afead12e598 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20Techet?= Date: Sun, 12 Oct 2014 23:33:51 +0200 Subject: [PATCH] Fix doxygen warnings Make documents_array public and accessible by doxygen and describe all parameters of tm_source_file_new(). --- src/document.h | 3 +-- tagmanager/src/tm_source_file.h | 7 ++++++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/document.h b/src/document.h index f62f78c1..eaa125ba 100644 --- a/src/document.h +++ b/src/document.h @@ -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; diff --git a/tagmanager/src/tm_source_file.h b/tagmanager/src/tm_source_file.h index fc70f15d..45f0e75a 100644 --- a/tagmanager/src/tm_source_file.h +++ b/tagmanager/src/tm_source_file.h @@ -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