summaryrefslogtreecommitdiffstats
path: root/src/dirdef.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/dirdef.h')
-rw-r--r--src/dirdef.h13
1 files changed, 8 insertions, 5 deletions
diff --git a/src/dirdef.h b/src/dirdef.h
index e7a6b0e..9a5346c 100644
--- a/src/dirdef.h
+++ b/src/dirdef.h
@@ -34,14 +34,14 @@ class FTextStream;
class DirDef;
-/** A list of directories */
+/** A list of directories. */
class DirList : public QList<DirDef>
{
public:
int compareItems(GCI item1,GCI item2);
};
-/** A directory */
+/** A model of a directory symbol. */
class DirDef : public Definition
{
public:
@@ -54,7 +54,7 @@ class DirDef : public Definition
QCString anchor() const { return QCString(); }
bool isLinkableInProject() const;
bool isLinkable() const;
- QCString displayName() const { return m_dispName; }
+ QCString displayName(bool=TRUE) const { return m_dispName; }
QCString shortName() const { return m_shortName; }
void addSubDir(DirDef *subdir);
FileList * getFiles() const { return m_fileList; }
@@ -105,6 +105,7 @@ class DirDef : public Definition
QDict<UsedDir> *m_usedDirs;
};
+/** Class representing a pair of FileDef objects */
class FilePair
{
public:
@@ -116,6 +117,7 @@ class FilePair
FileDef *m_dst;
};
+/** A sorted dictionary of FilePair objects. */
class FilePairDict : public SDict<FilePair>
{
public:
@@ -123,7 +125,7 @@ class FilePairDict : public SDict<FilePair>
int compareItems(GCI item1,GCI item2);
};
-/** Usage information of a directory . */
+/** Usage information of a directory. */
class UsedDir
{
public:
@@ -141,7 +143,7 @@ class UsedDir
bool m_inherited;
};
-/** A usage relation between two direction. */
+/** A usage relation between two directories. */
class DirRelation
{
public:
@@ -163,6 +165,7 @@ inline int DirList::compareItems(GCI item1,GCI item2)
return stricmp(((DirDef *)item1)->shortName(),((DirDef *)item2)->shortName());
}
+/** A sorted dictionary of DirDef objects. */
class DirSDict : public SDict<DirDef>
{
public: