summaryrefslogtreecommitdiffstats
path: root/src/docgroup.h
blob: 4ce9af96ad4e5d81a3aec975c8b10eb3206c073a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/******************************************************************************
 *
 * Copyright (C) 1997-2019 by Dimitri van Heesch.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */

#ifndef DOCGROUP_H
#define DOCGROUP_H

#include <qstack.h>
#include <qstring.h>
#include "membergroup.h"

class Entry;

class DocGroup
{
  public:
    DocGroup() {};

  public:
    void enterFile(const char *fileName,int);
    void leaveFile(const char *fileName,int line);
    void enterCompound(const char *fileName,int line,const char *name);
    void leaveCompound(const char *,int,const char * /*name*/);
    void open(Entry *e,const char *,int,bool implicit=false);
    void close(Entry *e,const char *fileName,int line,bool foundInline);
    void initGroupInfo(Entry *e);
    bool isEmpty() const;
    void clearHeader();
    void appendHeader(const char);
    void addDocs(Entry *e);

  private:
    int findExistingGroup(int &groupId,const MemberGroupInfo *info);
    int              m_openCount;
    QCString         m_memberGroupHeader;
    int              m_memberGroupId;
    QCString         m_memberGroupRelates;
    QCString         m_memberGroupDocs;
    QStack<Grouping> m_autoGroupStack;
    QCString         m_compoundName;
};

#endif