From a2ea725e1b0070ee8bcf55683157e67f5f727254 Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sun, 26 Aug 2018 13:53:48 +0200 Subject: Renamed (start/end)SimpleSect to (start/end)Examples. --- src/classdef.cpp | 4 ++-- src/htmlgen.cpp | 36 ++++++------------------------------ src/htmlgen.h | 7 ++----- src/latexgen.cpp | 14 +++----------- src/latexgen.h | 4 ++-- src/mangen.cpp | 25 ++++++++++++++++++++++--- src/mangen.h | 9 ++++----- src/memberdef.cpp | 21 ++------------------- src/outputgen.h | 6 ++---- src/outputlist.h | 9 ++++----- src/rtfgen.cpp | 17 +++++------------ src/rtfgen.h | 4 ++-- templates/html/doxygen.css | 12 +++++------- 13 files changed, 61 insertions(+), 107 deletions(-) diff --git a/src/classdef.cpp b/src/classdef.cpp index 83a29ed..1d72073 100644 --- a/src/classdef.cpp +++ b/src/classdef.cpp @@ -1013,13 +1013,13 @@ void ClassDef::writeDetailedDocumentationBody(OutputList &ol) // write examples if (hasExamples() && m_impl->exampleSDict) { - ol.startSimpleSect(BaseOutputDocInterface::Examples,0,0,theTranslator->trExamples()); + ol.startExamples(); ol.startDescForItem(); //ol.startParagraph(); writeExample(ol,m_impl->exampleSDict); //ol.endParagraph(); ol.endDescForItem(); - ol.endSimpleSect(BaseOutputDocInterface::Examples); + ol.endExamples(); } //ol.newParagraph(); writeSourceDef(ol,name()); diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp index 3f60ade..ee23fb8 100644 --- a/src/htmlgen.cpp +++ b/src/htmlgen.cpp @@ -1943,40 +1943,16 @@ void HtmlGenerator::endDescTableData() t << ""; } -void HtmlGenerator::startSimpleSect(SectionTypes sect, - const char *filename,const char *anchor, - const char *title) +void HtmlGenerator::startExamples() { - if (sect == BaseOutputDocInterface::Examples) - { - QCString className; - className="examples"; - t << "
"; - docify(title); - t << "
" << endl; - return; - } - - t << "
"; - if (filename) - { - writeObjectLink(0,filename,anchor,title); - } - else - { - docify(title); - } - t << "
"; + t << "
"; + docify(theTranslator->trExamples()); + t << "
"; } -void HtmlGenerator::endSimpleSect(SectionTypes sect) +void HtmlGenerator::endExamples() { - if (sect == BaseOutputDocInterface::Examples) - { - t << "
" << endl; - return; - } - t << "
"; + t << "
" << endl; } void HtmlGenerator::startParamList(ParamListTypes, diff --git a/src/htmlgen.h b/src/htmlgen.h index dad884f..221269f 100644 --- a/src/htmlgen.h +++ b/src/htmlgen.h @@ -246,13 +246,10 @@ class HtmlGenerator : public OutputGenerator void endCenter() { t << "" << endl; } void startSmall() { t << "" << endl; } void endSmall() { t << "" << endl; } - //void startDescList(SectionTypes) { t << "
" << endl; } - //void endDescList() { t << "
"; } - void startSimpleSect(SectionTypes,const char *,const char *,const char *); - void endSimpleSect(SectionTypes); + void startExamples(); + void endExamples(); void startParamList(ParamListTypes,const char *); void endParamList(); - //void writeDescItem() { t << "
" << endl; } void startSection(const char *,const char *,SectionInfo::SectionType); void endSection(const char *,SectionInfo::SectionType); void addIndexItem(const char *,const char *); diff --git a/src/latexgen.cpp b/src/latexgen.cpp index a0390be..204683e 100644 --- a/src/latexgen.cpp +++ b/src/latexgen.cpp @@ -2095,22 +2095,14 @@ void LatexGenerator::endDescItem() } } -void LatexGenerator::startSimpleSect(SectionTypes,const char *file, - const char *anchor,const char *title) +void LatexGenerator::startExamples() { t << "\\begin{Desc}\n\\item["; - if (file) - { - writeObjectLink(0,file,anchor,title); - } - else - { - docify(title); - } + docify(theTranslator->trExamples()); t << "]"; } -void LatexGenerator::endSimpleSect(SectionTypes) +void LatexGenerator::endExamples() { t << "\\end{Desc}" << endl; } diff --git a/src/latexgen.h b/src/latexgen.h index 2820b98..1460000 100644 --- a/src/latexgen.h +++ b/src/latexgen.h @@ -235,8 +235,8 @@ class LatexGenerator : public OutputGenerator const char *,const char *,const char *) {} void startDescList(SectionTypes) { t << "\\begin{Desc}\n\\item["; } void endDescList() { t << "\\end{Desc}" << endl; } - void startSimpleSect(SectionTypes,const char *,const char *,const char *); - void endSimpleSect(SectionTypes); + void startExamples(); + void endExamples(); void startParamList(ParamListTypes,const char *title); void endParamList(); void startDescForItem() { t << "\\par" << endl; } diff --git a/src/mangen.cpp b/src/mangen.cpp index 99be1dc..2a10db6 100644 --- a/src/mangen.cpp +++ b/src/mangen.cpp @@ -650,8 +650,25 @@ void ManGenerator::endSection(const char *,SectionInfo::SectionType type) } } -void ManGenerator::startSimpleSect(SectionTypes,const char *, - const char *,const char *title) +void ManGenerator::startExamples() +{ + if (!firstCol) + { t << endl << ".PP" << endl; + firstCol=TRUE; paragraph=TRUE; + col=0; + } + paragraph=FALSE; + startBold(); + docify(theTranslator->trExamples()); + endBold(); + paragraph=TRUE; +} + +void ManGenerator::endExamples() +{ +} + +void ManGenerator::startDescTable(const char *title) { if (!firstCol) { t << endl << ".PP" << endl; @@ -663,10 +680,12 @@ void ManGenerator::startSimpleSect(SectionTypes,const char *, docify(title); endBold(); paragraph=TRUE; + startDescForItem(); } -void ManGenerator::endSimpleSect(SectionTypes) +void ManGenerator::endDescTable() { + endDescForItem(); } void ManGenerator::startParamList(ParamListTypes,const char *title) diff --git a/src/mangen.h b/src/mangen.h index 55c826d..e109355 100644 --- a/src/mangen.h +++ b/src/mangen.h @@ -169,8 +169,8 @@ class ManGenerator : public OutputGenerator const char *,const char *,const char *) {} void startDescList(SectionTypes); void endDescList() {} - void startSimpleSect(SectionTypes,const char *,const char *,const char *); - void endSimpleSect(SectionTypes); + void startExamples(); + void endExamples(); void startParamList(ParamListTypes,const char *title); void endParamList(); //void writeDescItem(); @@ -197,9 +197,8 @@ class ManGenerator : public OutputGenerator void endContents() {} void writeNonBreakableSpace(int n) { int i; for (i=0;itrExamples()); + ol.startExamples(); ol.startDescForItem(); writeExample(ol,m_impl->exampleSDict); ol.endDescForItem(); - ol.endSimpleSect(BaseOutputDocInterface::Examples); + ol.endExamples(); } } @@ -2346,8 +2346,6 @@ void MemberDef::_writeEnumValues(OutputList &ol,Definition *container, { if (first) { - //ol.startSimpleSect(BaseOutputDocInterface::EnumValues,0,0,theTranslator->trEnumerationValues()+": "); - //ol.startDescForItem(); ol.startDescTable(theTranslator->trEnumerationValues()); } @@ -2355,28 +2353,17 @@ void MemberDef::_writeEnumValues(OutputList &ol,Definition *container, ol.addIndexItem(fmd->name(),ciname); ol.addIndexItem(ciname,fmd->name()); - //Doxygen::indexList->addIndexItem( - // ciname, // level1 - // fmd->name(), // level2 - // separateMemPages ? cfname : cfiname, // contRef - // cfname, // memRef - // fmd->anchor(), // anchor - // fmd); // memberdef Doxygen::indexList->addIndexItem(container,fmd); - //ol.writeListItem(); ol.startDescTableTitle(); ol.startDoxyAnchor(cfname,cname,fmd->anchor(),fmd->name(),fmd->argsString()); first=FALSE; - //ol.startEmphasis(); ol.docify(fmd->name()); - //ol.endEmphasis(); ol.disableAllBut(OutputGenerator::Man); ol.writeString(" "); ol.enableAll(); ol.endDoxyAnchor(cfname,fmd->anchor()); ol.endDescTableTitle(); - //ol.newParagraph(); ol.startDescTableData(); bool hasBrief = !fmd->briefDescription().isEmpty(); @@ -2407,11 +2394,7 @@ void MemberDef::_writeEnumValues(OutputList &ol,Definition *container, } if (!first) { - //ol.endItemList(); ol.endDescTable(); - //ol.endDescForItem(); - //ol.endSimpleSect(); - //ol.writeChar('\n'); } } } diff --git a/src/outputgen.h b/src/outputgen.h index a8943c0..9935bd9 100644 --- a/src/outputgen.h +++ b/src/outputgen.h @@ -146,7 +146,6 @@ class BaseOutputDocInterface : public CodeOutputInterface Warning, Par, Deprecated, Pre, Post, Invar, Remark, Attention, Todo, Test, RCS, */ - NONE, EnumValues, Examples }; @@ -281,9 +280,8 @@ class BaseOutputDocInterface : public CodeOutputInterface virtual void startSmall() = 0; virtual void endSmall() = 0; - virtual void startSimpleSect(SectionTypes t,const char *file, - const char *anchor,const char *title) = 0; - virtual void endSimpleSect(SectionTypes t = NONE) = 0; + virtual void startExamples() = 0; + virtual void endExamples() = 0; virtual void startParamList(ParamListTypes t,const char *title) = 0; virtual void endParamList() = 0; diff --git a/src/outputlist.h b/src/outputlist.h index 07c5207..5fd8017 100644 --- a/src/outputlist.h +++ b/src/outputlist.h @@ -321,11 +321,10 @@ class OutputList : public OutputDocInterface const char *title,const char *name) { forall(&OutputGenerator::writeInheritedSectionTitle,id,ref, file,anchor,title,name); } - void startSimpleSect(SectionTypes t,const char *file,const char *anchor, - const char *title) - { forall(&OutputGenerator::startSimpleSect,t,file,anchor,title); } - void endSimpleSect(SectionTypes t) - { forall(&OutputGenerator::endSimpleSect,t); } + void startExamples() + { forall(&OutputGenerator::startExamples); } + void endExamples() + { forall(&OutputGenerator::endExamples); } void startParamList(ParamListTypes t,const char *title) { forall(&OutputGenerator::startParamList,t,title); } void endParamList() diff --git a/src/rtfgen.cpp b/src/rtfgen.cpp index 4dd4c10..e2de5ab 100644 --- a/src/rtfgen.cpp +++ b/src/rtfgen.cpp @@ -2727,21 +2727,14 @@ void RTFGenerator::endMemberGroup(bool hasHeader) t << "}"; } -void RTFGenerator::startSimpleSect(SectionTypes,const char *file,const char *anchor,const char *title) +void RTFGenerator::startExamples() { - DBG_RTF(t << "{\\comment (startSimpleSect)}" << endl) + DBG_RTF(t << "{\\comment (startExamples)}" << endl) t << "{"; // ends at endDescList t << "{"; // ends at endDescTitle startBold(); newParagraph(); - if (file) - { - writeObjectLink(0,file,anchor,title); - } - else - { - docify(title); - } + docify(theTranslator->trExamples()); endBold(); t << "}"; newParagraph(); @@ -2749,9 +2742,9 @@ void RTFGenerator::startSimpleSect(SectionTypes,const char *file,const char *anc t << rtf_Style_Reset << rtf_DList_DepthStyle(); } -void RTFGenerator::endSimpleSect(SectionTypes) +void RTFGenerator::endExamples() { - DBG_RTF(t << "{\\comment (endSimpleSect)}" << endl) + DBG_RTF(t << "{\\comment (endExamples)}" << endl) m_omitParagraph = FALSE; newParagraph(); decrementIndentLevel(); diff --git a/src/rtfgen.h b/src/rtfgen.h index ed2a351..b6b32c7 100644 --- a/src/rtfgen.h +++ b/src/rtfgen.h @@ -164,8 +164,8 @@ class RTFGenerator : public OutputGenerator void writeInheritedSectionTitle(const char *,const char *,const char *, const char *,const char *,const char *) {} void startDescList(SectionTypes); - void startSimpleSect(SectionTypes,const char *,const char *,const char *); - void endSimpleSect(SectionTypes); + void startExamples(); + void endExamples(); void startParamList(ParamListTypes,const char *); void endParamList(); //void writeDescItem(); diff --git a/templates/html/doxygen.css b/templates/html/doxygen.css index 83cee43..4d9d168 100644 --- a/templates/html/doxygen.css +++ b/templates/html/doxygen.css @@ -687,7 +687,7 @@ dl.reflist dd { line-height: 14px; } -.params, .retval, .exception, .tparams, .examples { +.params, .retval, .exception, .tparams { margin-left: 0px; padding-left: 0px; } @@ -1112,14 +1112,12 @@ div.headertitle direction: rtl; } -dl -{ - padding: 0 0 0 10px; +dl { + padding: 0 0 0 0; } -/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ -dl.section -{ +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ +dl.section { margin-left: 0px; padding-left: 0px; } -- cgit v0.12