Imported Upstream version 1.8.2
[platform/upstream/doxygen.git] / src / example.h
1 /******************************************************************************
2  *
3  * $Id: example.h,v 1.10 2001/03/19 19:27:40 root Exp $
4  *
5  * Copyright (C) 1997-2012 by Dimitri van Heesch.
6  *
7  * Permission to use, copy, modify, and distribute this software and its
8  * documentation under the terms of the GNU General Public License is hereby 
9  * granted. No representations are made about the suitability of this software 
10  * for any purpose. It is provided "as is" without express or implied warranty.
11  * See the GNU General Public License for more details.
12  *
13  * Documents produced by Doxygen are derivative works derived from the
14  * input used in their production; they are not affected by this license.
15  *
16  */
17
18 #ifndef EXAMPLE_H
19 #define EXAMPLE_H
20
21 #include "qtbc.h"
22 #include <qdict.h>
23
24 class ClassDef;
25 class MemberName;
26
27 /** Data associated with an example. */
28 struct Example
29 {
30   QCString anchor;
31   QCString name;
32   QCString file;
33 };
34
35 /** A sorted dictionary of Example objects. */
36 class ExampleSDict : public SDict<Example>
37 {
38   public:
39     ExampleSDict(int size=17) : SDict<Example>(size) {}
40    ~ExampleSDict() {}
41     int compareItems(GCI item1,GCI item2)
42     {
43       return stricmp(((Example *)item1)->name,((Example *)item2)->name);
44     }
45 };
46
47 #endif