Root/
| Source at commit 1322 created 12 years 8 months ago. By meklort, Add doxygen to utils folder | |
|---|---|
| 1 | /******************************************************************************␊ |
| 2 | *␊ |
| 3 | * Copyright (C) 1997-2011 by Dimitri van Heesch.␊ |
| 4 | *␊ |
| 5 | * Permission to use, copy, modify, and distribute this software and its␊ |
| 6 | * documentation under the terms of the GNU General Public License is hereby ␊ |
| 7 | * granted. No representations are made about the suitability of this software ␊ |
| 8 | * for any purpose. It is provided "as is" without express or implied warranty.␊ |
| 9 | * See the GNU General Public License for more details.␊ |
| 10 | *␊ |
| 11 | * Documents produced by Doxygen are derivative works derived from the␊ |
| 12 | * input used in their production; they are not affected by this license.␊ |
| 13 | *␊ |
| 14 | */␊ |
| 15 | ␊ |
| 16 | #ifndef DOCSETS_H␊ |
| 17 | #define DOCSETS_H␊ |
| 18 | ␊ |
| 19 | #include "qtbc.h"␊ |
| 20 | #include <qstrlist.h>␊ |
| 21 | #include "sortdict.h"␊ |
| 22 | #include "ftextstream.h"␊ |
| 23 | #include "index.h"␊ |
| 24 | ␊ |
| 25 | class QFile;␊ |
| 26 | class Definition;␊ |
| 27 | ␊ |
| 28 | /*! A class that generates docset files.␊ |
| 29 | * These files can be used to create context help ␊ |
| 30 | * for use within Apple's Xcode 3.0 development environment␊ |
| 31 | */␊ |
| 32 | class DocSets : public IndexIntf␊ |
| 33 | {␊ |
| 34 | ␊ |
| 35 | public:␊ |
| 36 | DocSets();␊ |
| 37 | ~DocSets();␊ |
| 38 | void initialize();␊ |
| 39 | void finalize();␊ |
| 40 | void incContentsDepth();␊ |
| 41 | void decContentsDepth();␊ |
| 42 | void addContentsItem(bool isDir,␊ |
| 43 | const char *name, ␊ |
| 44 | const char *ref = 0, ␊ |
| 45 | const char *file = 0,␊ |
| 46 | const char *anchor = 0␊ |
| 47 | );␊ |
| 48 | void addIndexItem(Definition *context,MemberDef *md,const char *title);␊ |
| 49 | void addIndexFile(const char *name);␊ |
| 50 | void addImageFile(const char *) {}␊ |
| 51 | void addStyleSheetFile(const char *) {}␊ |
| 52 | ␊ |
| 53 | private:␊ |
| 54 | void writeToken(FTextStream &t, const Definition *d,␊ |
| 55 | const QCString &type, const QCString &lang,␊ |
| 56 | const char *scope=0, const char *anchor=0,␊ |
| 57 | const char *decl=0);␊ |
| 58 | struct NodeDef␊ |
| 59 | {␊ |
| 60 | NodeDef(bool d,const QCString &n,const QCString &r,␊ |
| 61 | const QCString &f,const QCString &a,int i) :␊ |
| 62 | isDir(d), name(n), ref(r), file(f), anchor(a),id(i) {}␊ |
| 63 | bool isDir;␊ |
| 64 | QCString name;␊ |
| 65 | QCString ref;␊ |
| 66 | QCString file;␊ |
| 67 | QCString anchor;␊ |
| 68 | int id;␊ |
| 69 | };␊ |
| 70 | QCString indent();␊ |
| 71 | QFile *m_nf;␊ |
| 72 | QFile *m_tf;␊ |
| 73 | FTextStream m_nts;␊ |
| 74 | FTextStream m_tts;␊ |
| 75 | int m_dc;␊ |
| 76 | int m_id;␊ |
| 77 | QArray<bool> m_firstNode;␊ |
| 78 | SDict<NodeDef> m_nodes;␊ |
| 79 | SDict<void> m_scopes;␊ |
| 80 | };␊ |
| 81 | ␊ |
| 82 | #endif /* DOCSETS_H */␊ |
| 83 | ␊ |
| 84 | |
