Fix doxygen warnings

Make documents_array public and accessible by doxygen and describe all
parameters of tm_source_file_new().
This commit is contained in:
Jiří Techet 2014-10-12 23:33:51 +02:00
parent 10a28b4191
commit 6d6dd7444b
2 changed files with 7 additions and 3 deletions

View File

@ -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;

View File

@ -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