src/example.h

   1 /******************************************************************************
   2  *
   3  *
   4  *
   5  * Copyright (C) 1997-2015 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 <qcstring.h>
  22 #include "sortdict.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   private:
  42     int compareValues(const Example *item1,const Example *item2) const
  43     {
  44       return qstricmp(item1->name,item2->name);
  45     }
  46 };
  47
  48 #endif