Merge pull request #1093 from kugel-/api-tmtag

Properly expose TMTag which already contains documented members.

doc/Doxyfile.in

@@ -798,6 +798,7 @@ INPUT                  = @top_srcdir@/src/ \
                          @top_srcdir@/tagmanager/src/tm_source_file.h \
                          @top_srcdir@/tagmanager/src/tm_workspace.c \
                          @top_srcdir@/tagmanager/src/tm_workspace.h \
+                         @top_srcdir@/tagmanager/src/tm_tag.h \
                          @top_srcdir@/tagmanager/src/tm_parser.h
 
 # This tag can be used to specify the character encoding of the source files

doc/Makefile.am

@@ -100,7 +100,9 @@ doxygen_dependencies = \
 	$(top_srcdir)/src/*.[ch] \
 	$(top_srcdir)/plugins/geanyplugin.h \
 	$(top_srcdir)/tagmanager/src/tm_source_file.[ch] \
-	$(top_srcdir)/tagmanager/src/tm_workspace.[ch]
+	$(top_srcdir)/tagmanager/src/tm_workspace.[ch] \
+	$(top_srcdir)/tagmanager/src/tm_tag.h \
+	$(top_srcdir)/tagmanager/src/tm_parser.h
 
 Doxyfile.stamp: Doxyfile $(doxygen_dependencies)
 	$(AM_V_GEN)$(DOXYGEN) Doxyfile && echo "" > $@

tagmanager/src/tm_source_file.h

@@ -33,7 +33,7 @@ typedef struct TMSourceFile
 	TMParserType lang; /* Programming language used */
 	char *file_name; /**< Full file name (inc. path) */
 	char *short_name; /**< Just the name of the file (without the path) */
-	GPtrArray *tags_array; /**< Sorted tag array obtained by parsing the object */
+	GPtrArray *tags_array; /**< Sorted tag array obtained by parsing the object. @elementtype{TMTag} */
 } TMSourceFile;
 
 GType tm_source_file_get_type(void);

tagmanager/src/tm_tag.h

@@ -80,7 +80,10 @@ typedef enum
 #define TAG_IMPL_VIRTUAL 'v' /**< Virtual implementation */
 #define TAG_IMPL_UNKNOWN 'x' /**< Unknown implementation */
 
-typedef struct _TMTag
+/**
+ * The TMTag structure represents a single tag in the tag manager.
+ **/
+typedef struct TMTag
 {
 	char *name; /**< Name of tag */
 	TMTagType type; /**< Tag Type */

tagmanager/src/tm_workspace.h

@@ -25,10 +25,10 @@ G_BEGIN_DECLS
  **/
 typedef struct TMWorkspace
 {
-	GPtrArray *global_tags; /**< Global tags loaded at startup */
-	GPtrArray *source_files; /**< An array of TMSourceFile pointers */
-	GPtrArray *tags_array; /**< Sorted tags from all source files 
-		(just pointers to source file tags, the tag objects are owned by the source files) */
+	GPtrArray *global_tags; /**< Global tags loaded at startup. @elementtype{TMTag} */
+	GPtrArray *source_files; /**< An array of TMSourceFile pointers. @elementtype{TMSourceFile} */
+	GPtrArray *tags_array; /**< Sorted tags from all source files
+		(just pointers to source file tags, the tag objects are owned by the source files). @elementtype{TMTag} */
 	GPtrArray *typename_array; /* Typename tags for syntax highlighting (pointers owned by source files) */
 	GPtrArray *global_typename_array; /* Like above for global tags */
 } TMWorkspace;