jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactored DoxygenEntity class

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13724 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Marko Klopcic 2012-08-26 15:34:46 +00:00
commit c9eda79264
7 changed files with 155 additions and 253 deletions
Download patch file Download diff file Expand all files Collapse all files

27
Source/DoxygenTranslator/src/DoxygenEntity.h
View file

@ -36,29 +36,28 @@ typedef enum {
COMMAND
} DoxyCommandEnum;
class DoxygenEntity;
typedef std::list <DoxygenEntity> DoxygenEntityList;
typedef DoxygenEntityList::iterator DoxygenEntityListIt;
typedef DoxygenEntityList::const_iterator DoxygenEntityListCIt;
/*
* Structure to represent a doxygen comment entry
*/
struct DoxygenEntity {
class DoxygenEntity {
public:
std::string typeOfEntity;
std::list < DoxygenEntity > entityList;
std::string data;
bool isLeaf;
DoxygenEntityList entityList;
DoxygenEntity(std::string typeEnt);
DoxygenEntity(std::string typeEnt, std::string param1);
DoxygenEntity(std::string typeEnt, std::list < DoxygenEntity > &entList);
DoxygenEntity(const std::string &typeEnt);
DoxygenEntity(const std::string &typeEnt, const std::string &param1);
DoxygenEntity(const std::string & typeEnt, const DoxygenEntityList &entList);
void printEntity(int level) const;
};
/*
* Functor that sorts entities by javaDoc standard order for commands.
* NOTE: will not behave entirely properly until "First level" comments
* such as brief descriptions are TAGGED as such
*/
struct CompareDoxygenEntities {
bool operator() (DoxygenEntity & first, DoxygenEntity & second);
};
#endif