[geany/geany] 4903d7: TM: use the same format of docstrings as in the rest of Geany
Jiří Techet
git-noreply at xxxxx
Sat Nov 8 18:57:53 UTC 2014
Branch: refs/heads/master
Author: Jiří Techet <techet at gmail.com>
Committer: Jiří Techet <techet at gmail.com>
Date: Sat, 18 Oct 2014 19:40:10 UTC
Commit: 4903d79dcc7ed1e8e0d54f85f00d07dbb62e33dc
https://github.com/geany/geany/commit/4903d79dcc7ed1e8e0d54f85f00d07dbb62e33dc
Log Message:
-----------
TM: use the same format of docstrings as in the rest of Geany
Modified Paths:
--------------
tagmanager/src/tm_source_file.h
tagmanager/src/tm_tag.h
tagmanager/src/tm_tagmanager.h
tagmanager/src/tm_workspace.c
tagmanager/src/tm_workspace.h
Modified: tagmanager/src/tm_source_file.h
78 lines changed, 39 insertions(+), 39 deletions(-)
===================================================================
@@ -33,44 +33,44 @@ extern "C"
#define FALLBACK(X,Y) (X)?(X):(Y)
-/*!
+/**
The TMSourceFile structure represents the source file and its tags in the tag manager.
*/
typedef struct
{
- langType 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; /*!< Tags obtained by parsing the object */
+ langType 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; /**< Tags obtained by parsing the object */
} TMSourceFile;
-/*! 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.
+/** 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.
* */
TMSourceFile *tm_source_file_new(const char *file_name, gboolean update, const char *name);
-/*! Updates the source file by reparsing. The tags array and
+/** Updates the source file by reparsing. The tags array and
the tags themselves are destroyed and re-created, hence any other tag arrays
pointing to these tags should be rebuilt as well. All sorting information is
also lost. The language parameter is automatically set the first time the file
is parsed.
- \param source_file The source file to update.
- \param update_workspace If set to TRUE, sends an update signal to the workspace if required. You should
+ @param source_file The source file to update.
+ @param update_workspace If set to TRUE, sends an update signal to the workspace if required. You should
always set this to TRUE if you are calling this function directly.
*/
void tm_source_file_update(TMSourceFile *source_file, gboolean update_workspace);
-/*! Frees a TMSourceFile structure, including all contents */
+/** Frees a TMSourceFile structure, including all contents */
void tm_source_file_free(TMSourceFile *source_file);
-/*!
+/**
Given a file name, returns a newly allocated string containing the realpath()
of the file.
- \param file_name The original file_name
- \return A newly allocated string containing the real path to the file. NULL if none is available.
+ @param file_name The original file_name
+ @return A newly allocated string containing the real path to the file. NULL if none is available.
*/
gchar *tm_get_real_path(const gchar *file_name);
@@ -95,30 +95,30 @@ void tm_source_file_destroy(TMSourceFile *source_file);
other tag arrays pointing to these tags should be rebuilt as well. All sorting
information is also lost. The language parameter is automatically set the first
time the file is parsed.
- \param source_file The source file to update with a buffer.
- \param text_buf A text buffer. The user should take care of allocate and free it after
+ @param source_file The source file to update with a buffer.
+ @param text_buf A text buffer. The user should take care of allocate and free it after
the use here.
- \param buf_size The size of text_buf.
- \param update_workspace If set to TRUE, sends an update signal to the workspace if required. You should
+ @param buf_size The size of text_buf.
+ @param update_workspace If set to TRUE, sends an update signal to the workspace if required. You should
always set this to TRUE if you are calling this function directly.
- \return TRUE if the file was parsed, FALSE otherwise.
+ @return TRUE if the file was parsed, FALSE otherwise.
*/
void tm_source_file_buffer_update(TMSourceFile *source_file, guchar* text_buf,
gint buf_size, gboolean update_workspace);
/* Parses the source file and regenarates the tags.
- \param source_file The source file to parse
- \return TRUE on success, FALSE on failure
- \sa tm_source_file_update()
+ @param source_file The source file to parse
+ @return TRUE on success, FALSE on failure
+ @see tm_source_file_update()
*/
gboolean tm_source_file_parse(TMSourceFile *source_file);
/* Parses the text-buffer and regenarates the tags.
- \param source_file The source file to parse
- \param text_buf The text buffer to parse
- \param buf_size The size of text_buf.
- \return TRUE on success, FALSE on failure
- \sa tm_source_file_update()
+ @param source_file The source file to parse
+ @param text_buf The text buffer to parse
+ @param buf_size The size of text_buf.
+ @return TRUE on success, FALSE on failure
+ @see tm_source_file_update()
*/
gboolean tm_source_file_buffer_parse(TMSourceFile *source_file, guchar* text_buf, gint buf_size);
@@ -126,30 +126,30 @@ gboolean tm_source_file_buffer_parse(TMSourceFile *source_file, guchar* text_buf
This function is registered into the ctags parser when a file is parsed for
the first time. The function is then called by the ctags parser each time
it finds a new tag. You should not have to use this function.
- \sa tm_source_file_parse()
+ @see tm_source_file_parse()
*/
int tm_source_file_tags(const tagEntryInfo *tag);
/*
Writes all tags of a source file (including the file tag itself) to the passed
file pointer.
- \param source_file The source file to write.
- \param fp The file pointer to write to.
- \param attrs The attributes to write.
- \return TRUE on success, FALSE on failure.
+ @param source_file The source file to write.
+ @param fp The file pointer to write to.
+ @param attrs The attributes to write.
+ @return TRUE on success, FALSE on failure.
*/
gboolean tm_source_file_write(TMSourceFile *source_file, FILE *fp, guint attrs);
/* Gets the name associated with the language index.
- \param lang The language index.
- \return The language name, or NULL.
+ @param lang The language index.
+ @return The language name, or NULL.
*/
const gchar *tm_source_file_get_lang_name(gint lang);
/* Gets the language index for \a name.
- \param name The language name.
- \return The language index, or -2.
+ @param name The language name.
+ @return The language index, or -2.
*/
gint tm_source_file_get_named_lang(const gchar *name);
Modified: tagmanager/src/tm_tag.h
248 lines changed, 124 insertions(+), 124 deletions(-)
===================================================================
@@ -10,7 +10,7 @@
#ifndef TM_TAG_H
#define TM_TAG_H
-/* \file
+/* @file
The TMTag structure and the associated functions are used to manipulate
tags and arrays of tags. Normally, you should not create tags individually
but through an external interface such as tm_source_file_parse(), which generates
@@ -37,41 +37,41 @@ extern "C"
{
#endif
-/*! Use the TM_TAG() macro to cast a pointer to (TMTag *) */
+/** Use the TM_TAG() macro to cast a pointer to (TMTag *) */
#define TM_TAG(tag) ((TMTag *) tag)
-/*!
+/**
Types of tags. It is a bitmask so that multiple tag types can
be used simultaneously by 'OR'-ing them bitwise.
e.g. tm_tag_class_t | tm_tag_struct_t
*/
typedef enum
{
- tm_tag_undef_t = 0, /*!< Unknown type */
- tm_tag_class_t = 1, /*!< Class declaration */
- tm_tag_enum_t = 2, /*!< Enum declaration */
- tm_tag_enumerator_t = 4, /*!< Enumerator value */
- tm_tag_field_t = 8, /*!< Field (Java only) */
- tm_tag_function_t = 16, /*!< Function definition */
- tm_tag_interface_t = 32, /*!< Interface (Java only) */
- tm_tag_member_t = 64, /*!< Member variable of class/struct */
- tm_tag_method_t = 128, /*!< Class method (Java only) */
- tm_tag_namespace_t = 256, /*!< Namespace declaration */
- tm_tag_package_t = 512, /*!< Package (Java only) */
- tm_tag_prototype_t = 1024, /*!< Function prototype */
- tm_tag_struct_t = 2048, /*!< Struct declaration */
- tm_tag_typedef_t = 4096, /*!< Typedef */
- tm_tag_union_t = 8192, /*!< Union */
- tm_tag_variable_t = 16384, /*!< Variable */
- tm_tag_externvar_t = 32768, /*!< Extern or forward declaration */
- tm_tag_macro_t = 65536, /*!< Macro (without arguments) */
- tm_tag_macro_with_arg_t = 131072, /*!< Parameterized macro */
- tm_tag_file_t = 262144, /*!< File (Pseudo tag) */
- tm_tag_other_t = 524288, /*!< Other (non C/C++/Java tag) */
- tm_tag_max_t = 1048575 /*!< Maximum value of TMTagType */
+ tm_tag_undef_t = 0, /**< Unknown type */
+ tm_tag_class_t = 1, /**< Class declaration */
+ tm_tag_enum_t = 2, /**< Enum declaration */
+ tm_tag_enumerator_t = 4, /**< Enumerator value */
+ tm_tag_field_t = 8, /**< Field (Java only) */
+ tm_tag_function_t = 16, /**< Function definition */
+ tm_tag_interface_t = 32, /**< Interface (Java only) */
+ tm_tag_member_t = 64, /**< Member variable of class/struct */
+ tm_tag_method_t = 128, /**< Class method (Java only) */
+ tm_tag_namespace_t = 256, /**< Namespace declaration */
+ tm_tag_package_t = 512, /**< Package (Java only) */
+ tm_tag_prototype_t = 1024, /**< Function prototype */
+ tm_tag_struct_t = 2048, /**< Struct declaration */
+ tm_tag_typedef_t = 4096, /**< Typedef */
+ tm_tag_union_t = 8192, /**< Union */
+ tm_tag_variable_t = 16384, /**< Variable */
+ tm_tag_externvar_t = 32768, /**< Extern or forward declaration */
+ tm_tag_macro_t = 65536, /**< Macro (without arguments) */
+ tm_tag_macro_with_arg_t = 131072, /**< Parameterized macro */
+ tm_tag_file_t = 262144, /**< File (Pseudo tag) */
+ tm_tag_other_t = 524288, /**< Other (non C/C++/Java tag) */
+ tm_tag_max_t = 1048575 /**< Maximum value of TMTagType */
} TMTagType;
-/*!
+/**
Tag Attributes. Note that some attributes are available to file
pseudotags only. Attributes are useful for specifying as arguments
to the builtin sort and dedup functions, and during printing or writing
@@ -81,39 +81,39 @@ typedef enum
*/
typedef enum
{
- tm_tag_attr_none_t = 0, /*!< Undefined */
- tm_tag_attr_name_t = 1, /*!< Tag Name */
- tm_tag_attr_type_t = 2, /*!< Tag Type */
- tm_tag_attr_file_t = 4, /*!< File in which tag exists */
- tm_tag_attr_line_t = 8, /*!< Line number of tag */
- tm_tag_attr_pos_t = 16, /*!< Byte position of tag in the file (Obsolete) */
- tm_tag_attr_scope_t = 32, /*!< Scope of the tag */
- tm_tag_attr_inheritance_t = 64, /*!< Parent classes */
- tm_tag_attr_arglist_t = 128, /*!< Argument list */
- tm_tag_attr_local_t = 256, /*!< If it has local scope */
- tm_tag_attr_time_t = 512, /*!< Modification time (File tag only) */
- tm_tag_attr_vartype_t = 1024, /*!< Variable Type */
- tm_tag_attr_access_t = 2048, /*!< Access type (public/protected/private) */
- tm_tag_attr_impl_t = 4096, /*!< Implementation (e.g. virtual) */
- tm_tag_attr_lang_t = 8192, /*!< Language (File tag only) */
- tm_tag_attr_inactive_t = 16384, /*!< Inactive file (File tag only, obsolete) */
- tm_tag_attr_pointer_t = 32768, /*!< Pointer type */
- tm_tag_attr_max_t = 65535 /*!< Maximum value */
+ tm_tag_attr_none_t = 0, /**< Undefined */
+ tm_tag_attr_name_t = 1, /**< Tag Name */
+ tm_tag_attr_type_t = 2, /**< Tag Type */
+ tm_tag_attr_file_t = 4, /**< File in which tag exists */
+ tm_tag_attr_line_t = 8, /**< Line number of tag */
+ tm_tag_attr_pos_t = 16, /**< Byte position of tag in the file (Obsolete) */
+ tm_tag_attr_scope_t = 32, /**< Scope of the tag */
+ tm_tag_attr_inheritance_t = 64, /**< Parent classes */
+ tm_tag_attr_arglist_t = 128, /**< Argument list */
+ tm_tag_attr_local_t = 256, /**< If it has local scope */
+ tm_tag_attr_time_t = 512, /**< Modification time (File tag only) */
+ tm_tag_attr_vartype_t = 1024, /**< Variable Type */
+ tm_tag_attr_access_t = 2048, /**< Access type (public/protected/private) */
+ tm_tag_attr_impl_t = 4096, /**< Implementation (e.g. virtual) */
+ tm_tag_attr_lang_t = 8192, /**< Language (File tag only) */
+ tm_tag_attr_inactive_t = 16384, /**< Inactive file (File tag only, obsolete) */
+ tm_tag_attr_pointer_t = 32768, /**< Pointer type */
+ tm_tag_attr_max_t = 65535 /**< Maximum value */
} TMTagAttrType;
-/*! Tag access type for C++/Java member functions and variables */
-#define TAG_ACCESS_PUBLIC 'p' /*!< Public member */
-#define TAG_ACCESS_PROTECTED 'r' /*!< Protected member */
-#define TAG_ACCESS_PRIVATE 'v' /*!< Private member */
-#define TAG_ACCESS_FRIEND 'f' /*!< Friend members/functions */
-#define TAG_ACCESS_DEFAULT 'd' /*!< Default access (Java) */
-#define TAG_ACCESS_UNKNOWN 'x' /*!< Unknown access type */
+/** Tag access type for C++/Java member functions and variables */
+#define TAG_ACCESS_PUBLIC 'p' /**< Public member */
+#define TAG_ACCESS_PROTECTED 'r' /**< Protected member */
+#define TAG_ACCESS_PRIVATE 'v' /**< Private member */
+#define TAG_ACCESS_FRIEND 'f' /**< Friend members/functions */
+#define TAG_ACCESS_DEFAULT 'd' /**< Default access (Java) */
+#define TAG_ACCESS_UNKNOWN 'x' /**< Unknown access type */
-/*! Tag implementation type for functions */
-#define TAG_IMPL_VIRTUAL 'v' /*!< Virtual implementation */
-#define TAG_IMPL_UNKNOWN 'x' /*!< Unknown implementation */
+/** Tag implementation type for functions */
+#define TAG_IMPL_VIRTUAL 'v' /**< Virtual implementation */
+#define TAG_IMPL_UNKNOWN 'x' /**< Unknown implementation */
-/*!
+/**
This structure holds all information about a tag, including the file
pseudo tag. It should always be created indirectly with one of the tag
creation functions such as tm_source_file_parse() or tm_tag_new_from_file().
@@ -122,32 +122,32 @@ typedef enum
*/
typedef struct _TMTag
{
- char *name; /*!< Name of tag */
- TMTagType type; /*!< Tag Type */
+ char *name; /**< Name of tag */
+ TMTagType type; /**< Tag Type */
union
{
- /*! These are *real* tag attributes */
+ /** These are *real* tag attributes */
struct
{
- TMSourceFile *file; /*!< File in which the tag occurs */
- gulong line; /*!< Line number of the tag */
- gboolean local; /*!< Is the tag of local scope */
+ TMSourceFile *file; /**< File in which the tag occurs */
+ gulong line; /**< Line number of the tag */
+ gboolean local; /**< Is the tag of local scope */
guint pointerOrder;
- char *arglist; /*!< Argument list (functions/prototypes/macros) */
- char *scope; /*!< Scope of tag */
- char *inheritance; /*!< Parent classes */
- char *var_type; /*!< Variable type (maps to struct for typedefs) */
- char access; /*!< Access type (public/protected/private/etc.) */
- char impl; /*!< Implementation (e.g. virtual) */
+ char *arglist; /**< Argument list (functions/prototypes/macros) */
+ char *scope; /**< Scope of tag */
+ char *inheritance; /**< Parent classes */
+ char *var_type; /**< Variable type (maps to struct for typedefs) */
+ char access; /**< Access type (public/protected/private/etc.) */
+ char impl; /**< Implementation (e.g. virtual) */
} entry;
- /*! These are pseudo tag attributes representing a file */
+ /** These are pseudo tag attributes representing a file */
struct
{
- time_t timestamp; /*!< Time of parsing of the file */
- langType lang; /*!< Programming language of the file */
+ time_t timestamp; /**< Time of parsing of the file */
+ langType lang; /**< Programming language of the file */
} file;
} atts;
- gint refcount; /*!< the reference count of the tag */
+ gint refcount; /**< the reference count of the tag */
} TMTag;
@@ -179,20 +179,20 @@ GType tm_tag_get_type(void) G_GNUC_CONST;
used by the ctags parsers. Note that the TMTag structure must be malloc()ed
before calling this function. This function is called by tm_tag_new() - you
should not need to call this directly.
- \param tag The TMTag structure to initialize
- \param file Pointer to a TMSourceFile struct (it is assigned to the file member)
- \param tag_entry Tag information gathered by the ctags parser
- \return TRUE on success, FALSE on failure
+ @param tag The TMTag structure to initialize
+ @param file Pointer to a TMSourceFile struct (it is assigned to the file member)
+ @param tag_entry Tag information gathered by the ctags parser
+ @return TRUE on success, FALSE on failure
*/
gboolean tm_tag_init(TMTag *tag, TMSourceFile *file, const tagEntryInfo *tag_entry);
/*
Initializes an already malloc()ed TMTag structure by reading a tag entry
line from a file. The structure should be allocated beforehand.
- \param tag The TMTag structure to populate
- \param file The TMSourceFile struct (assigned to the file member)
- \param fp FILE pointer from where the tag line is read
- \return TRUE on success, FALSE on FAILURE
+ @param tag The TMTag structure to populate
+ @param file The TMSourceFile struct (assigned to the file member)
+ @param fp FILE pointer from where the tag line is read
+ @return TRUE on success, FALSE on FAILURE
*/
gboolean tm_tag_init_from_file(TMTag *tag, TMSourceFile *file, FILE *fp);
@@ -210,24 +210,24 @@ gboolean tm_tag_init_from_file_ctags(TMTag *tag, TMSourceFile *file, FILE *fp);
/*
Creates a new tag structure from a tagEntryInfo pointer and a TMSOurceFile pointer
and returns a pointer to it.
- \param file - Pointer to the TMSourceFile structure containing the tag
- \param tag_entry Contains tag information generated by ctags
- \return the new TMTag structure. This should be free()-ed using tm_tag_free()
+ @param file - Pointer to the TMSourceFile structure containing the tag
+ @param tag_entry Contains tag information generated by ctags
+ @return the new TMTag structure. This should be free()-ed using tm_tag_free()
*/
TMTag *tm_tag_new(TMSourceFile *file, const tagEntryInfo *tag_entry);
/*
Same as tm_tag_new() except that the tag attributes are read from file.
- \param mode langType to use for the tag.
+ @param mode langType to use for the tag.
*/
TMTag *tm_tag_new_from_file(TMSourceFile *file, FILE *fp, gint mode, TMFileFormat format);
/*
Writes tag information to the given FILE *.
- \param tag The tag information to write.
- \param file FILE pointer to which the tag information is written.
- \param attrs Attributes to be written (bitmask).
- \return TRUE on success, FALSE on failure.
+ @param tag The tag information to write.
+ @param file FILE pointer to which the tag information is written.
+ @param attrs Attributes to be written (bitmask).
+ @return TRUE on success, FALSE on failure.
*/
gboolean tm_tag_write(TMTag *tag, FILE *file, guint attrs);
@@ -248,10 +248,10 @@ GPtrArray *tm_tags_merge_big_small(GPtrArray *big_array, GPtrArray *small_array,
/*
Sort an array of tags on the specified attribuites using the inbuilt comparison
function.
- \param tags_array The array of tags to be sorted
- \param sort_attributes Attributes to be sorted on (int array terminated by 0)
- \param dedup Whether to deduplicate the sorted array
- \return TRUE on success, FALSE on failure
+ @param tags_array The array of tags to be sorted
+ @param sort_attributes Attributes to be sorted on (int array terminated by 0)
+ @param dedup Whether to deduplicate the sorted array
+ @return TRUE on success, FALSE on failure
*/
gboolean tm_tags_sort(GPtrArray *tags_array, TMTagAttrType *sort_attributes, gboolean dedup);
@@ -259,13 +259,13 @@ gboolean tm_tags_sort(GPtrArray *tags_array, TMTagAttrType *sort_attributes, gbo
This function should be used whenever more involved sorting is required. For this,
you need to write a function as per the prototype of TMTagCompareFunc() and pass
the function as a parameter to this function.
- \param tags_array Array of tags to be sorted
- \param compare_func A function which takes two pointers to (TMTag *)s and returns
+ @param tags_array Array of tags to be sorted
+ @param compare_func A function which takes two pointers to (TMTag *)s and returns
0, 1 or -1 depending on whether the first value is equal to, greater than or less that
the second
- \param dedup Whether to deduplicate the sorted array. Note that the same comparison
+ @param dedup Whether to deduplicate the sorted array. Note that the same comparison
function will be used
- \return TRUE on success, FALSE on failure
+ @return TRUE on success, FALSE on failure
*/
gboolean tm_tags_custom_sort(GPtrArray *tags_array, TMTagCompareFunc compare_func, gboolean dedup);
@@ -274,39 +274,39 @@ gboolean tm_tags_custom_sort(GPtrArray *tags_array, TMTagCompareFunc compare_fun
The returned value is a GPtrArray which should be free-d with a call to
g_ptr_array_free(array, TRUE). However, do not free the tags themselves since they
are not duplicated.
- \param tags_array The original array of tags
- \param tag_types - The tag types to extract. Can be a bitmask. For example, passing
+ @param tags_array The original array of tags
+ @param tag_types - The tag types to extract. Can be a bitmask. For example, passing
(tm_tag_typedef_t | tm_tag_struct_t) will extract all typedefs and structures from
the original array.
- \return an array of tags (NULL on failure)
+ @return an array of tags (NULL on failure)
*/
GPtrArray *tm_tags_extract(GPtrArray *tags_array, guint tag_types);
/*
Removes NULL tag entries from an array of tags. Called after tm_tags_dedup() and
tm_tags_custom_dedup() since these functions substitute duplicate entries with NULL
- \param tags_array Array of tags to dedup
- \return TRUE on success, FALSE on failure
+ @param tags_array Array of tags to dedup
+ @return TRUE on success, FALSE on failure
*/
gboolean tm_tags_prune(GPtrArray *tags_array);
/*
Deduplicates an array on tags using the inbuilt comparison function based on
the attributes specified. Called by tm_tags_sort() when dedup is TRUE.
- \param tags_array Array of tags to dedup.
- \param sort_attributes Attributes the array is sorted on. They will be deduped
+ @param tags_array Array of tags to dedup.
+ @param sort_attributes Attributes the array is sorted on. They will be deduped
on the same criteria.
- \return TRUE on success, FALSE on failure
+ @return TRUE on success, FALSE on failure
*/
gboolean tm_tags_dedup(GPtrArray *tags_array, TMTagAttrType *sort_attributes);
/*
This is a more powerful form of tm_tags_dedup() since it can accomodate user
defined comparison functions. Called by tm_tags_custom_sort() is dedup is TRUE.
- \param tags_array Array of tags to dedup.
- \compare_function Comparison function
- \return TRUE on success, FALSE on FAILURE
- \sa TMTagCompareFunc
+ @param tags_array Array of tags to dedup.
+ @param compare_func Comparison function
+ @return TRUE on success, FALSE on FAILURE
+ @see TMTagCompareFunc
*/
gboolean tm_tags_custom_dedup(GPtrArray *tags_array, TMTagCompareFunc compare_func);
@@ -314,34 +314,34 @@ gboolean tm_tags_custom_dedup(GPtrArray *tags_array, TMTagCompareFunc compare_fu
Returns a pointer to the position of the first matching tag in a (sorted) tags array.
The passed array of tags should be already sorted by name for optimal performance. If
\c tags_array_sorted is set to FALSE, it may be unsorted but the lookup will be slower.
- \param tags_array Tag array (may be sorted on name)
- \param name Name of the tag to locate.
- \param partial If TRUE, matches the first part of the name instead of doing exact match.
- \param tags_array_sorted If TRUE, the passed \c tags_array is sorted by name so it can be
+ @param tags_array Tag array (may be sorted on name)
+ @param name Name of the tag to locate.
+ @param partial If TRUE, matches the first part of the name instead of doing exact match.
+ @param tags_array_sorted If TRUE, the passed \c tags_array is sorted by name so it can be
searched with binary search. Otherwise it is searched linear which is obviously slower.
- \param tagCount Return location of the matched tags.
+ @param tagCount Return location of the matched tags.
*/
TMTag **tm_tags_find(const GPtrArray *tags_array, const char *name,
gboolean partial, gboolean tags_array_sorted, int * tagCount);
/*
Completely frees an array of tags.
- \param tags_array Array of tags to be freed.
- \param free_array Whether the GptrArray is to be freed as well.
+ @param tags_array Array of tags to be freed.
+ @param free_array Whether the GptrArray is to be freed as well.
*/
void tm_tags_array_free(GPtrArray *tags_array, gboolean free_all);
#if 0
/*
Destroys a TMTag structure, i.e. frees all elements except the tag itself.
- \param tag The TMTag structure to destroy
- \sa tm_tag_free()
+ @param tag The TMTag structure to destroy
+ @see tm_tag_free()
*/
void tm_tag_destroy(TMTag *tag);
/*
Destroys all data in the tag and frees the tag structure as well.
- \param tag Pointer to a TMTag structure
+ @param tag Pointer to a TMTag structure
*/
void tm_tag_free(gpointer tag);
#endif
@@ -349,33 +349,33 @@ void tm_tag_free(gpointer tag);
/*
Drops a reference from a TMTag. If the reference count reaches 0, this function
destroys all data in the tag and frees the tag structure as well.
- \param tag Pointer to a TMTag structure
+ @param tag Pointer to a TMTag structure
*/
void tm_tag_unref(TMTag *tag);
/*
Adds a reference to a TMTag.
- \param tag Pointer to a TMTag structure
- \return the passed-in TMTag
+ @param tag Pointer to a TMTag structure
+ @return the passed-in TMTag
*/
TMTag *tm_tag_ref(TMTag *tag);
/*
Returns the type of tag as a string
- \param tag The tag whose type is required
+ @param tag The tag whose type is required
*/
const char *tm_tag_type_name(const TMTag *tag);
/*
Returns the TMTagType given the name of the type. Reverse of tm_tag_type_name.
- \param tag_name Name of the tag type
+ @param tag_name Name of the tag type
*/
TMTagType tm_tag_name_type(const char* tag_name);
/*
Prints information about a tag to the given file pointer.
- \param tag The tag whose info is required.
- \fp The file pointer of teh file to print the info to.
+ @param tag The tag whose info is required.
+ @param fp The file pointer of teh file to print the info to.
*/
void tm_tag_print(TMTag *tag, FILE *fp);
Modified: tagmanager/src/tm_tagmanager.h
8 lines changed, 4 insertions(+), 4 deletions(-)
===================================================================
@@ -17,20 +17,20 @@
#include "tm_parser.h"
#endif /* GEANY_PRIVATE */
-/*! \mainpage Introduction
- \section Introduction
+/** @mainpage Introduction
+ @section Introduction
TagManager is a library and a set of utility programs which can be integrated into
Integrated Development Environments to provide features such as code completion,
calltips, etc. Tag Manager is based on <a href="http://ctags.sourceforge.net">
Exuberent Ctags</a> with some added features.
- \section Licence
+ @section Licence
TagManager is <a href="http://www.gnu.org/philosophy/free-sw.html">free software</a>,
licenced under the <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>. You can only
use it with free software (GPL compatible) projects. This is chiefly because it uses
code from ctags which is under GPL.
*/
-/*! \file
+/** @file
Include this file in all programs using the tag manager library. Including this
automatically includes all the necessary files, namely, tm_tag.h, tm_source_file.h
and tm_workspace.h
Modified: tagmanager/src/tm_workspace.c
2 lines changed, 1 insertions(+), 1 deletions(-)
===================================================================
@@ -7,7 +7,7 @@
*
*/
-/*!
+/**
* @file tm_workspace.h
The TMWorkspace structure is meant to be used as a singleton to store application
wide tag information.
Modified: tagmanager/src/tm_workspace.h
92 lines changed, 46 insertions(+), 46 deletions(-)
===================================================================
@@ -21,34 +21,34 @@ extern "C"
#endif
-/*! The Tag Manager Workspace. This is a singleton object containing a list
+/** The Tag Manager Workspace. This is a singleton object containing a list
of individual source files. There is also a global tag list
which can be loaded or created. This contains global tags gleaned from
/usr/include, etc. and should be used for autocompletion, calltips, etc.
*/
typedef struct
{
- 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
+ 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) */
} TMWorkspace;
-/*! Adds a source file to the workspace.
- \param source_file The source file to add to the workspace.
- \return TRUE on success, FALSE on failure (e.g. object already exixts).
+/** Adds a source file to the workspace.
+ @param source_file The source file to add to the workspace.
+ @return TRUE on success, FALSE on failure (e.g. object already exixts).
*/
gboolean tm_workspace_add_source_file(TMSourceFile *source_file);
-/*! Removes a member object from the workspace if it exists.
- \param source_file Pointer to the source file to be removed.
- \param do_free Whether the source file is to be freed as well.
- \param update Whether to update workspace objects.
- \return TRUE on success, FALSE on failure (e.g. the source file does not exist).
+/** Removes a member object from the workspace if it exists.
+ @param source_file Pointer to the source file to be removed.
+ @param do_free Whether the source file is to be freed as well.
+ @param update Whether to update workspace objects.
+ @return TRUE on success, FALSE on failure (e.g. the source file does not exist).
*/
gboolean tm_workspace_remove_source_file(TMSourceFile *source_file, gboolean do_free, gboolean update);
-/*! Calls tm_source_file_update() for all workspace member source files and creates
+/** Calls tm_source_file_update() for all workspace member source files and creates
workspace tag array. Use if you want to globally refresh the workspace.
*/
void tm_workspace_update(void);
@@ -67,9 +67,9 @@ const TMWorkspace *tm_get_workspace(void);
/* Loads the global tag list from the specified file. The global tag list should
have been first created using tm_workspace_create_global_tags().
- \param tags_file The file containing global tags.
- \return TRUE on success, FALSE on failure.
- \sa tm_workspace_create_global_tags()
+ @param tags_file The file containing global tags.
+ @return TRUE on success, FALSE on failure.
+ @see tm_workspace_create_global_tags()
*/
gboolean tm_workspace_load_global_tags(const char *tags_file, gint mode);
/*gboolean tm_workspace_load_global_tags(const char *tags_file);*/
@@ -77,13 +77,13 @@ gboolean tm_workspace_load_global_tags(const char *tags_file, gint mode);
/* Creates a list of global tags. Ideally, this should be created once during
installations so that all users can use the same file. Thsi is because a full
scale global tag list can occupy several megabytes of disk space.
- \param pre_process The pre-processing command. This is executed via system(),
+ @param pre_process The pre-processing command. This is executed via system(),
so you can pass stuff like 'gcc -E -dD -P `gnome-config --cflags gnome`'.
- \param includes Include files to process. Wildcards such as '/usr/include/a*.h'
+ @param includes Include files to process. Wildcards such as '/usr/include/a*.h'
are allowed.
- \param tags_file The file where the tags will be stored.
- \param lang The language to use for the tags file.
- \return TRUE on success, FALSE on failure.
+ @param tags_file The file where the tags will be stored.
+ @param lang The language to use for the tags file.
+ @return TRUE on success, FALSE on failure.
*/
gboolean tm_workspace_create_global_tags(const char *pre_process, const char **includes,
int includes_count, const char *tags_file, int lang);
@@ -98,35 +98,35 @@ void tm_workspace_recreate_tags_array(void);
void tm_workspace_dump(void);
/* Returns all matching tags found in the workspace.
- \param name The name of the tag to find.
- \param type The tag types to return (TMTagType). Can be a bitmask.
- \param attrs The attributes to sort and dedup on (0 terminated integer array).
- \param partial Whether partial match is allowed.
- \param lang Specifies the language(see the table in parsers.h) of the tags to be found,
+ @param name The name of the tag to find.
+ @param type The tag types to return (TMTagType). Can be a bitmask.
+ @param attrs The attributes to sort and dedup on (0 terminated integer array).
+ @param partial Whether partial match is allowed.
+ @param lang Specifies the language(see the table in parsers.h) of the tags to be found,
-1 for all
- \return Array of matching tags. Do not free() it since it is a static member.
+ @return Array of matching tags. Do not free() it since it is a static member.
*/
const GPtrArray *tm_workspace_find(const char *name, int type, TMTagAttrType *attrs
, gboolean partial, langType lang);
/* Returns all matching tags found in the workspace.
- \param name The name of the tag to find.
- \param scope The scope name of the tag to find, or NULL.
- \param type The tag types to return (TMTagType). Can be a bitmask.
- \param attrs The attributes to sort and dedup on (0 terminated integer array).
- \param partial Whether partial match is allowed.
- \param lang Specifies the language(see the table in parsers.h) of the tags to be found,
+ @param name The name of the tag to find.
+ @param scope The scope name of the tag to find, or NULL.
+ @param type The tag types to return (TMTagType). Can be a bitmask.
+ @param attrs The attributes to sort and dedup on (0 terminated integer array).
+ @param partial Whether partial match is allowed.
+ @param lang Specifies the language(see the table in parsers.h) of the tags to be found,
-1 for all
- \return Array of matching tags. Do not free() it since it is a static member.
+ @return Array of matching tags. Do not free() it since it is a static member.
*/
const GPtrArray *
tm_workspace_find_scoped (const char *name, const char *scope, gint type,
TMTagAttrType *attrs, gboolean partial, langType lang, gboolean global_search);
/* Returns all matching members tags found in given struct/union/class name.
- \param name Name of the struct/union/class.
- \param file_tags A GPtrArray of edited file TMTag pointers (for search speedup, can be NULL).
- \return A GPtrArray of TMTag pointers to struct/union/class members */
+ @param name Name of the struct/union/class.
+ @param file_tags A GPtrArray of edited file TMTag pointers (for search speedup, can be NULL).
+ @return A GPtrArray of TMTag pointers to struct/union/class members */
const GPtrArray *tm_workspace_find_scope_members(const GPtrArray *file_tags,
const char *scope_name,
gboolean find_global,
@@ -137,21 +137,21 @@ tm_workspace_find_namespace_members (const GPtrArray * file_tags, const char *na
gboolean search_global);
/* Returns TMTag which "own" given line
- \param line Current line in edited file.
- \param file_tags A GPtrArray of edited file TMTag pointers.
- \param tag_types the tag types to include in the match
- \return TMTag pointers to owner tag. */
+ @param line Current line in edited file.
+ @param file_tags A GPtrArray of edited file TMTag pointers.
+ @param tag_types the tag types to include in the match
+ @return TMTag pointers to owner tag. */
const TMTag *tm_get_current_tag(GPtrArray *file_tags, const gulong line, const guint tag_types);
/* Returns TMTag to function or method which "own" given line
- \param line Current line in edited file.
- \param file_tags A GPtrArray of edited file TMTag pointers.
- \return TMTag pointers to owner function. */
+ @param line Current line in edited file.
+ @param file_tags A GPtrArray of edited file TMTag pointers.
+ @return TMTag pointers to owner function. */
const TMTag *tm_get_current_function(GPtrArray *file_tags, const gulong line);
/* Returns a list of parent classes for the given class name
- \param name Name of the class
- \return A GPtrArray of TMTag pointers (includes the TMTag for the class) */
+ @param name Name of the class
+ @return A GPtrArray of TMTag pointers (includes the TMTag for the class) */
const GPtrArray *tm_workspace_get_parents(const gchar *name);
/* Frees the workspace structure and all child source files. Use only when
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
More information about the Commits
mailing list