Merge pull request #890 from kugel-/gtkdoc-hdr
[geany-mirror.git] / tagmanager / src / tm_tagmanager.h
blob450b4834de0a5c6c261f78d3bb18288716d5b3f8
1 /*
3 * Copyright (c) 2001-2002, Biswapesh Chattopadhyay
5 * This source code is released for free distribution under the terms of the
6 * GNU General Public License.
8 */
10 #ifndef TM_TAGMANAGER_H
11 #define TM_TAGMANAGER_H
13 #include "tm_tag.h"
14 #include "tm_workspace.h"
15 #include "tm_source_file.h"
16 #ifdef GEANY_PRIVATE
17 #include "tm_parser.h"
18 #endif /* GEANY_PRIVATE */
20 /** @mainpage Introduction
21 @section Introduction
22 TagManager is a library and a set of utility programs which can be integrated into
23 Integrated Development Environments to provide features such as code completion,
24 calltips, etc. Tag Manager is based on <a href="http://ctags.sourceforge.net">
25 Exuberent Ctags</a> with some added features.
26 @section Licence
27 TagManager is <a href="http://www.gnu.org/philosophy/free-sw.html">free software</a>,
28 licenced under the <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>. You can only
29 use it with free software (GPL compatible) projects. This is chiefly because it uses
30 code from ctags which is under GPL.
33 /** @file
34 Include this file in all programs using the tag manager library. Including this
35 automatically includes all the necessary files, namely, tm_tag.h, tm_source_file.h
36 and tm_workspace.h
39 #endif /* TM_TAGMANAGER_H */