Skip to content

D
doxverilog
Commit 5b23c957 authored by Dimitri van Heesch's avatar Dimitri van Heesch
Browse files
Options

Release-1.5.5-20080316

parent 8051d0cf
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 177 additions and 2244 deletions
INSTALL
View file @ 5b23c957
DOXYGEN Version 1.5.5-20080309
DOXYGEN Version 1.5.5-20080316
Please read the installation section of the manual
(http://www.doxygen.org/install.html) for instructions.
--------
Dimitri van Heesch (09 March 2008)
Dimitri van Heesch (16 March 2008)
README
View file @ 5b23c957
DOXYGEN Version 1.5.5_20080309
DOXYGEN Version 1.5.5_20080316
Please read INSTALL for compilation instructions.
......@@ -17,4 +17,4 @@ to subscribe to the lists or to visit the archives.
Enjoy,
Dimitri van Heesch (dimitri@stack.nl) (09 March 2008)
Dimitri van Heesch (dimitri@stack.nl) (16 March 2008)
addon/doxmlparser/include/doxmlintf.h
View file @ 5b23c957
......@@ -35,11 +35,14 @@ class INode;
class IDocInternal;
class IDocRoot;
#define VIRTUAL_DESTRUCTOR(x) virtual ~x() {}
/*! \brief Read only interface to a string.
*/
class IString
{
public:
VIRTUAL_DESTRUCTOR(IString)
/*! Returns a latin1 character representation of the string. */
virtual const char *latin1() const = 0;
/*! Returns a 16-bit unicode character representation of the character at
......@@ -60,6 +63,7 @@ class IString
class ILinkedText
{
public:
VIRTUAL_DESTRUCTOR(ILinkedText)
enum Kind { Kind_Text, Kind_Ref };
virtual Kind kind() const = 0;
};
......@@ -69,6 +73,7 @@ class ILinkedText
class ILT_Text : public ILinkedText
{
public:
VIRTUAL_DESTRUCTOR(ILT_Text)
virtual const IString *text() const = 0;
};
......@@ -77,6 +82,7 @@ class ILT_Text : public ILinkedText
class ILT_Ref : public ILinkedText
{
public:
VIRTUAL_DESTRUCTOR(ILT_Ref)
enum TargetKind { Member, Compound };
virtual const IString *id() const = 0;
virtual TargetKind targetKind() const = 0;
......@@ -89,6 +95,7 @@ class ILT_Ref : public ILinkedText
class ILinkedTextIterator
{
public:
VIRTUAL_DESTRUCTOR(ILinkedTextIterator)
virtual ILinkedText *toFirst() = 0;
virtual ILinkedText *toLast() = 0;
virtual ILinkedText *toNext() = 0;
......@@ -101,6 +108,7 @@ class ILinkedTextIterator
class IParam
{
public:
VIRTUAL_DESTRUCTOR(IParam)
virtual ILinkedTextIterator *type() const = 0;
virtual const IString * declarationName() const = 0;
virtual const IString * definitionName() const = 0;
......@@ -113,6 +121,7 @@ class IParam
class IParamIterator
{
public:
VIRTUAL_DESTRUCTOR(IParamIterator)
virtual IParam *toFirst() = 0;
virtual IParam *toLast() = 0;
virtual IParam *toNext() = 0;
......@@ -124,6 +133,7 @@ class IParamIterator
class IMemberReference
{
public:
VIRTUAL_DESTRUCTOR(IMemberReference)
virtual IMember *member() const = 0;
virtual const IString * name() const = 0;
virtual const IString * scope() const = 0;
......@@ -135,6 +145,7 @@ class IMemberReference
class IMemberReferenceIterator
{
public:
VIRTUAL_DESTRUCTOR(IMemberReferenceIterator)
virtual IMemberReference *toFirst() = 0;
virtual IMemberReference *toLast() = 0;
virtual IMemberReference *toNext() = 0;
......@@ -146,6 +157,7 @@ class IMemberReferenceIterator
class IDoc
{
public:
VIRTUAL_DESTRUCTOR(IDoc)
enum Kind
{
Invalid = 0, // 0
......@@ -492,6 +504,7 @@ class IDocRoot : public IDoc
class IDocIterator
{
public:
VIRTUAL_DESTRUCTOR(IDocIterator)
virtual IDoc *toFirst() = 0;
virtual IDoc *toLast() = 0;
virtual IDoc *toNext() = 0;
......@@ -503,12 +516,14 @@ class IDocIterator
class IEdgeLabel
{
public:
VIRTUAL_DESTRUCTOR(IEdgeLabel)
virtual const IString * label() const = 0;
};
class IEdgeLabelIterator
{
public:
VIRTUAL_DESTRUCTOR(IEdgeLabelIterator)
virtual IEdgeLabel *toFirst() = 0;
virtual IEdgeLabel *toLast() = 0;
virtual IEdgeLabel *toNext() = 0;
......@@ -520,6 +535,7 @@ class IEdgeLabelIterator
class IChildNode
{
public:
VIRTUAL_DESTRUCTOR(IChildNode)
enum NodeRelation { PublicInheritance, ProtectedInheritance,
PrivateInheritance, Usage, TemplateInstance
};
......@@ -532,6 +548,7 @@ class IChildNode
class IChildNodeIterator
{
public:
VIRTUAL_DESTRUCTOR(IChildNodeIterator)
virtual IChildNode *toFirst() = 0;
virtual IChildNode *toLast() = 0;
virtual IChildNode *toNext() = 0;
......@@ -543,6 +560,7 @@ class IChildNodeIterator
class INode
{
public:
VIRTUAL_DESTRUCTOR(INode)
virtual const IString * id() const = 0;
virtual const IString * label() const = 0;
virtual const IString * linkId() const = 0;
......@@ -552,6 +570,7 @@ class INode
class INodeIterator
{
public:
VIRTUAL_DESTRUCTOR(INodeIterator)
virtual INode *toFirst() = 0;
virtual INode *toLast() = 0;
virtual INode *toNext() = 0;
......@@ -563,12 +582,14 @@ class INodeIterator
class IGraph
{
public:
VIRTUAL_DESTRUCTOR(IGraph)
virtual INodeIterator *nodes() const = 0;
};
class IMember
{
public:
VIRTUAL_DESTRUCTOR(IMember)
enum MemberKind { Invalid=0,
Define, Property, Variable, Typedef, Enum,
Function, Signal, Prototype, Friend, DCOP, Slot,
......@@ -675,6 +696,7 @@ class IEnumValue : public IMember
class IInclude
{
public:
VIRTUAL_DESTRUCTOR(IInclude)
virtual const IString * name() const = 0;
virtual const IString * refId() const = 0;
virtual bool isLocal() const = 0;
......@@ -683,6 +705,7 @@ class IInclude
class IIncludeIterator
{
public:
VIRTUAL_DESTRUCTOR(IIncludeIterator)
virtual IInclude *toFirst() = 0;
virtual IInclude *toLast() = 0;
virtual IInclude *toNext() = 0;
......@@ -694,6 +717,7 @@ class IIncludeIterator
class IMemberIterator
{
public:
VIRTUAL_DESTRUCTOR(IMemberIterator)
virtual IMember *toFirst() = 0;
virtual IMember *toLast() = 0;
virtual IMember *toNext() = 0;
......@@ -721,6 +745,7 @@ class IEnum : public IMember
class ISection
{
public:
VIRTUAL_DESTRUCTOR(ISection)
/*! Possible section types */
enum SectionKind
{ Invalid=0,
......@@ -804,6 +829,7 @@ class IUserDefined : public ISection
class ISectionIterator
{
public:
VIRTUAL_DESTRUCTOR(ISectionIterator)
virtual ISection *toFirst() = 0;
virtual ISection *toLast() = 0;
virtual ISection *toNext() = 0;
......@@ -840,6 +866,7 @@ class ISectionIterator
class ICompound
{
public:
VIRTUAL_DESTRUCTOR(ICompound)
/*! Represents the kind of compounds recognised by doxygen. */
enum CompoundKind { Invalid=0,
Class, Struct, Union, Interface, Protocol, Category,
......@@ -900,6 +927,7 @@ class ICompound
class ICompoundIterator
{
public:
VIRTUAL_DESTRUCTOR(ICompoundIterator)
virtual void toFirst() = 0;
virtual void toLast() = 0;
virtual void toNext() = 0;
......@@ -911,6 +939,7 @@ class ICompoundIterator
class IRelatedCompound
{
public:
VIRTUAL_DESTRUCTOR(IRelatedCompound)
enum Protection { Public, Protected, Private };
enum Kind { Normal, Virtual };
virtual ICompound *compound() const = 0;
......@@ -923,6 +952,7 @@ class IRelatedCompound
class IRelatedCompoundIterator
{
public:
VIRTUAL_DESTRUCTOR(IRelatedCompoundIterator)
virtual IRelatedCompound *toFirst() = 0;
virtual IRelatedCompound *toLast() = 0;
virtual IRelatedCompound *toNext() = 0;
......@@ -1042,6 +1072,7 @@ class IPage : public ICompound
class IDoxygen
{
public:
VIRTUAL_DESTRUCTOR(IDoxygen)
/*! Returns an iterator that can be used to iterate over the list
* of compounds found in the project.
......
addon/doxmlparser/src/basehandler.h
View file @ 5b23c957
......@@ -165,7 +165,7 @@ template<class T> class BaseHandler : public QXmlDefaultHandler,
return TRUE;
}
StartElementHandlerT *handler = m_startHandlers[name];
StartElementHandlerT *handler = ElementMapper<T>::m_startHandlers[name];
if (handler)
{
(*handler)(attrib);
......@@ -205,7 +205,7 @@ template<class T> class BaseHandler : public QXmlDefaultHandler,
}
else if (m_skipUntil.isEmpty())
{
EndElementHandlerT *handler = m_endHandlers[name];
EndElementHandlerT *handler = ElementMapper<T>::m_endHandlers[name];
if (handler)
{
(*handler)();
......@@ -301,7 +301,7 @@ template<class T> class BaseFallBackHandler : public ElementMapper<T>,
bool handleStartElement(const QString & name,
const QXmlAttributes & attrib)
{
StartElementHandlerT *handler = m_startHandlers[name];
StartElementHandlerT *handler = ElementMapper<T>::m_startHandlers[name];
if (handler)
{
(*handler)(attrib);
......@@ -311,7 +311,7 @@ template<class T> class BaseFallBackHandler : public ElementMapper<T>,
}
bool handleEndElement(const QString &name)
{
EndElementHandlerT *handler = m_endHandlers[name];
EndElementHandlerT *handler = ElementMapper<T>::m_endHandlers[name];
if (handler)
{
(*handler)();
......
addon/doxmlparser/src/doxmlintf.h deleted 100644 → 0
View file @ 8051d0cf
This diff is collapsed.
addon/doxmlparser/src/doxmlintf.h 0 → 120000
View file @ 5b23c957
../include/doxmlintf.h
\ No newline at end of file
configure
View file @ 5b23c957
......@@ -20,7 +20,7 @@ doxygen_version_minor=5
doxygen_version_revision=5
#NOTE: Setting version_mmn to "NO" will omit mmn info from the package.
doxygen_version_mmn=20080309
doxygen_version_mmn=20080316
bin_dirs=`echo $PATH | sed -e "s/:/ /g"`
......
src/index.cpp
View file @ 5b23c957
......@@ -2937,7 +2937,7 @@ void writeIndex(OutputList &ol)
ol.startIndexSection(isMainPage);
if (mainPageHasTitle())
{
ol.parseDoc(defFileName,defLine,Doxygen::mainPage,0,Doxygen::mainPage->title(),FALSE,FALSE);
ol.parseText(Doxygen::mainPage->title());
}
else
{
......@@ -2954,13 +2954,22 @@ void writeIndex(OutputList &ol)
bool first=Doxygen::mainPage==0;
for (pdi.toFirst();(pd=pdi.current());++pdi)
{
if (!pd->getGroupDef() && !pd->isReference())
if (!pd->getGroupDef() && !pd->isReference() &&
!pd->hasParentPage()
)
{
QCString title = pd->title();
if (title.isEmpty()) title=pd->name();
ol.startIndexSection(isPageDocumentation);
ol.parseText(title);
ol.endIndexSection(isPageDocumentation);
ol.pushGeneratorState(); // write TOC title (RTF only)
ol.disableAllBut(OutputGenerator::RTF);
ol.startIndexSection(isPageDocumentation2);
ol.parseText(title);
ol.endIndexSection(isPageDocumentation2);
ol.popGeneratorState();
ol.writeAnchor(0,pd->name());
ol.writePageLink(pd->getOutputFileBase(),first);
first=FALSE;
......
src/index.h
View file @ 5b23c957
......@@ -115,6 +115,7 @@ enum IndexSections
isFileDocumentation,
isExampleDocumentation,
isPageDocumentation,
isPageDocumentation2,
isEndIndex
};
......
src/latexgen.cpp
View file @ 5b23c957
......@@ -236,7 +236,7 @@ static void writeDefaultHeaderPart1(QTextStream &t)
s=extraPackages.next();
}
t << "\\makeindex\n"
"\\setcounter{tocdepth}{1}\n"
"\\setcounter{tocdepth}{3}\n"
"\\renewcommand{\\footrulewidth}{0.4pt}\n"
"\\begin{document}\n";
if (theTranslator->idLanguage()=="greek") t << "\\selectlanguage{greek}\n";
......@@ -585,6 +585,8 @@ void LatexGenerator::startIndexSection(IndexSections is)
t << "{"; //Page Documentation}\n";
}
break;
case isPageDocumentation2:
break;
case isEndIndex:
break;
}
......@@ -793,6 +795,8 @@ void LatexGenerator::endIndexSection(IndexSections is)
#endif
}
break;
case isPageDocumentation2:
break;
case isEndIndex:
t << "\\printindex\n";
t << "\\end{document}\n";
......@@ -1104,7 +1108,7 @@ void LatexGenerator::endMemberHeader()
void LatexGenerator::startMemberDoc(const char *clname,
const char *memname,
const char *,
const char *)
const char *title)
{
if (memname && memname[0]!='@')
{
......@@ -1141,6 +1145,9 @@ void LatexGenerator::startMemberDoc(const char *clname,
// escapeMakeIndexChars(this,t,memname);
// t << "]";
//}
t << "[";
escapeMakeIndexChars(title);
t << "]";
t << "{\\setlength{\\rightskip}{0pt plus 5cm}";
disableLinks=TRUE;
}
......@@ -1181,9 +1188,16 @@ void LatexGenerator::writeAnchor(const char *fName,const char *name)
{
//printf("LatexGenerator::writeAnchor(%s,%s)\n",fName,name);
t << "\\label{" << name << "}" << endl;
if (fName && Config_getBool("PDF_HYPERLINKS"))
if (Config_getBool("PDF_HYPERLINKS"))
{
t << "\\hypertarget{" << stripPath(fName) << "_" << name << "}{}" << endl;
if (fName)
{
t << "\\hypertarget{" << stripPath(fName) << "_" << name << "}{}" << endl;
}
else
{
t << "\\hypertarget{" << name << "}{}" << endl;
}
}
}
......
src/pagedef.cpp
View file @ 5b23c957
......@@ -13,13 +13,14 @@ PageDef::PageDef(const char *f,int l,const char *n,
: Definition(f,l,n), m_title(t)
{
setDocumentation(d,f,l);
subPageDict = new PageSDict(7);
pageScope = 0;
m_subPageDict = new PageSDict(7);
m_pageScope = 0;
m_nestingLevel = 0;
}
PageDef::~PageDef()
{
delete subPageDict;
delete m_subPageDict;
}
void PageDef::findSectionsInDocumentation()
......@@ -46,11 +47,18 @@ void PageDef::addInnerCompound(Definition *def)
if (def->definitionType()==Definition::TypePage)
{
PageDef *pd = (PageDef*)def;
subPageDict->append(pd->name(),pd);
m_subPageDict->append(pd->name(),pd);
def->setOuterScope(this);
pd->setNestingLevel(m_nestingLevel+1);
}
}
bool PageDef::hasParentPage() const
{
return getOuterScope() &&
getOuterScope()->definitionType()==Definition::TypePage;
}
void PageDef::writeDocumentation(OutputList &ol)
{
//outputList->disable(OutputGenerator::Man);
......@@ -62,6 +70,17 @@ void PageDef::writeDocumentation(OutputList &ol)
startFile(ol,pageName,pageName,title(),HLI_None,TRUE);
ol.pushGeneratorState();
if (m_nestingLevel>0) // a sub page
{
// do not generate sub page output for RTF and LaTeX, as these are
// part of their parent page
ol.disableAll();
ol.enable(OutputGenerator::Man);
ol.enable(OutputGenerator::Html);
}
if (getOuterScope()!=Doxygen::globalScope && !Config_getBool("DISABLE_INDEX"))
{
getOuterScope()->writeNavigationPath(ol);
......@@ -80,6 +99,7 @@ void PageDef::writeDocumentation(OutputList &ol)
// for Latex the section is already generated as a chapter in the index!
ol.pushGeneratorState();
ol.disable(OutputGenerator::Latex);
ol.disable(OutputGenerator::RTF);
SectionInfo *si=0;
if (!title().isEmpty() && !name().isEmpty() &&
(si=Doxygen::sectionDict.find(pageName))!=0)
......@@ -93,18 +113,11 @@ void PageDef::writeDocumentation(OutputList &ol)
}
ol.popGeneratorState();
ol.startTextBlock();
ol.parseDoc(docFile(), // fileName
docLine(), // startLine
this, // context
0, // memberdef
documentation(), // docStr
TRUE, // index words
FALSE // not an example
);
ol.endTextBlock();
writePageDocumentation(ol);
ol.popGeneratorState();
endFile(ol);
//outputList->enable(OutputGenerator::Man);
if (!Config_getString("GENERATE_TAGFILE").isEmpty())
{
......@@ -131,6 +144,53 @@ void PageDef::writeDocumentation(OutputList &ol)
}
}
void PageDef::writePageDocumentation(OutputList &ol)
{
ol.startTextBlock();
ol.parseDoc(docFile(), // fileName
docLine(), // startLine
this, // context
0, // memberdef
documentation(), // docStr
TRUE, // index words
FALSE // not an example
);
ol.endTextBlock();
if (hasSubPages())
{
// for printed documentation we write subpages as section's of the
// parent page.
ol.pushGeneratorState();
ol.disableAll();
ol.enable(OutputGenerator::Latex);
ol.enable(OutputGenerator::RTF);
PageSDict::Iterator pdi(*m_subPageDict);
PageDef *subPage=pdi.toFirst();
for (pdi.toFirst();(subPage=pdi.current());++pdi)
{
SectionInfo::SectionType sectionType = SectionInfo::Paragraph;
switch (m_nestingLevel)
{
case 0: sectionType = SectionInfo::Page; break;
case 1: sectionType = SectionInfo::Section; break;
case 2: sectionType = SectionInfo::Subsection; break;
case 3: sectionType = SectionInfo::Subsubsection; break;
default: sectionType = SectionInfo::Paragraph; break;
}
QCString title = subPage->title();
if (title.isEmpty()) title = subPage->name();
ol.startSection(subPage->name(),title,sectionType);
ol.parseText(title);
ol.endSection(subPage->name(),sectionType);
subPage->writePageDocumentation(ol);
}
ol.popGeneratorState();
}
}
bool PageDef::visibleInIndex() const
{
return // not part of a group
......@@ -153,7 +213,11 @@ bool PageDef::documentedPage() const
bool PageDef::hasSubPages() const
{
return subPageDict->count()>0;
return m_subPageDict->count()>0;
}
void PageDef::setNestingLevel(int l)
{
m_nestingLevel = l;
}
src/pagedef.h
View file @ 5b23c957
......@@ -35,7 +35,6 @@ class PageDef : public Definition
{
return isLinkableInProject() || isReference();
}
void addSubPage(PageDef *def);
void writeDocumentation(OutputList &ol);
// functions to get a uniform interface with Definitions
......@@ -43,21 +42,25 @@ class PageDef : public Definition
void findSectionsInDocumentation();
QCString title() const { return m_title; }
GroupDef * getGroupDef() const;
PageSDict * getSubPages() const { return subPageDict; }
PageSDict * getSubPages() const { return m_subPageDict; }
void setFileName(const char *name) { m_fileName = name; }
void addInnerCompound(Definition *d);
bool visibleInIndex() const;
bool documentedPage() const;
bool hasSubPages() const;
void setPageScope(Definition *d){ pageScope = d; }
Definition *getPageScope() const { return pageScope; }
bool hasParentPage() const;
void setPageScope(Definition *d){ m_pageScope = d; }
Definition *getPageScope() const { return m_pageScope; }
private:
void setNestingLevel(int l);
void writePageDocumentation(OutputList &ol);
QCString m_fileName;
QCString m_title;
GroupDef *m_inGroup;
PageSDict *subPageDict; // list of pages in the group
Definition *pageScope;
PageSDict *m_subPageDict; // list of pages in the group
Definition *m_pageScope;
int m_nestingLevel;
};
class PageSDict : public SDict<PageDef>
......
src/rtfgen.cpp
View file @ 5b23c957
......@@ -39,8 +39,8 @@
#include "dirdef.h"
#include "vhdldocgen.h"
//#define DBG_RTF(x) x;
#define DBG_RTF(x)
#define DBG_RTF(x) x;
//#define DBG_RTF(x)
static QCString dateToRTFDateString()
{
......@@ -515,6 +515,10 @@ void RTFGenerator::startIndexSection(IndexSections is)
{
//Page Documentation
beginRTFChapter();
}
break;
case isPageDocumentation2:
{
t << "{\\tc \\v ";
}
break;
......@@ -833,7 +837,7 @@ void RTFGenerator::endIndexSection(IndexSections is)
{
//#error "fix me in the same way as the latex index..."
//t << "{\\tc \\v " << theTranslator->trPageDocumentation() << "}"<< endl;
t << "}"<< endl;
//t << "}"<< endl;
//PageSDict::Iterator pdi(*Doxygen::pageSDict);
//PageDef *pd=pdi.toFirst();
//bool first=TRUE;
......@@ -850,6 +854,12 @@ void RTFGenerator::endIndexSection(IndexSections is)
//}
}
break;
case isPageDocumentation2:
{
t << "}";
t << "\\par " << rtf_Style_Reset << endl;
}
break;
case isEndIndex:
beginRTFChapter();
t << rtf_Style["Heading1"]->reference;
......@@ -1607,8 +1617,9 @@ void RTFGenerator::startSection(const char *,const char *title,SectionInfo::Sect
void RTFGenerator::endSection(const char *lab,SectionInfo::SectionType)
{
DBG_RTF(t << "{\\comment (endSection)}" << endl)
newParagraph();
// make bookmark
m_omitParagraph=FALSE;
newParagraph();
writeAnchor(0,lab);
t << "}";
}
......@@ -1813,7 +1824,7 @@ void RTFGenerator::writeAnchor(const char *fileName,const char *name)
anchor+=name;
}
DBG_RTF(t <<"{\\comment writeAncheor (" << anchor << ")}" << endl)
DBG_RTF(t <<"{\\comment writeAnchor (" << anchor << ")}" << endl)
t << "{\\bkmkstart " << rtfFormatBmkStr(anchor) << "}" << endl;
t << "{\\bkmkend " << rtfFormatBmkStr(anchor) << "}" << endl;
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment