Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Api tmtag #1093

Merged
merged 3 commits into from Jun 29, 2016
Merged

Api tmtag #1093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
989af29
api: formally put struct TMTag into the API
kugel- Jun 27, 2016
cef4751
doxygen: make doxygen scan necessary tagmanager files
kugel- Jun 27, 2016
659b277
api: annotate element types in the TMWorkspace arrays
kugel- Jun 28, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/Doxyfile.in
View file
Open in desktop
Expand Up @@ -794,6 +794,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
Expand Down
4 changes: 3 additions & 1 deletion doc/Makefile.am
View file
Open in desktop
Expand Up @@ -97,7 +97,9 @@ doxygen_sources = \
$(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_sources)
$(AM_V_GEN)$(DOXYGEN) Doxyfile && echo "" > $@
Expand Down
5 changes: 4 additions & 1 deletion tagmanager/src/tm_tag.h
View file
Open in desktop
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

meh, why rename?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uhm, for consistency with other TM* structs. Not sure if it's truly necessary for gir (probably not)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's not, please drop this. yeah it's more consistent so that's kinda good, but it changes a name so it could break some users, and I'd rather not play with that so close to the release.
Yes I know it's private and all.

Copy link
Member Author

@kugel- kugel- Jun 29, 2016 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would it be the last opportunity?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any identifier starting with an underscore followed by an upper-case letter is reserved for the implementation, I believe.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.

  • **/
    +typedef struct TMTag

Why would it be the last opportunity?

Because the struct itself becomes documented now.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hum, good point indeed, the struct name itself is exposed. So yeah maybe it's good this way.

{
char *name; /**< Name of tag */
TMTagType type; /**< Tag Type */
Expand Down
8 changes: 4 additions & 4 deletions tagmanager/src/tm_workspace.h
View file
Open in desktop
Expand Up @@ -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;
Expand Down