Added rudimentary support for django like template system for output creation. (784a67d2) · Commits · Elphel / doxverilog

src/classdef.cpp

+34 −15

Original line number	Diff line number	Diff line
		@@ -916,9 +916,15 @@ static void writeTemplateSpec(OutputList &ol,Definition *d,
		}
		}

		bool ClassDef::hasBriefDescription() const
		{
		static bool briefMemberDesc = Config_getBool("BRIEF_MEMBER_DESC");
		return !briefDescription().isEmpty() && briefMemberDesc;
		}

		void ClassDef::writeBriefDescription(OutputList &ol,bool exampleFlag)
		{
		if (!briefDescription().isEmpty() && Config_getBool("BRIEF_MEMBER_DESC"))
		if (hasBriefDescription())
		{
		ol.startParagraph();
		ol.generateDoc(briefFile(),briefLine(),this,0,
		@@ -929,10 +935,7 @@ void ClassDef::writeBriefDescription(OutputList &ol,bool exampleFlag)
		ol.enable(OutputGenerator::RTF);
		ol.popGeneratorState();

		if (Config_getBool("REPEAT_BRIEF") \|\|
		!documentation().isEmpty() \|\|
		exampleFlag
		)
		if (hasDetailedDescription() \|\| exampleFlag)
		{
		writeMoreLink(ol,anchor());
		}
		@@ -990,14 +993,20 @@ void ClassDef::writeDetailedDocumentationBody(OutputList &ol)
		ol.endTextBlock();
		}

		bool ClassDef::hasDetailedDescription() const
		{
		static bool repeatBrief = Config_getBool("REPEAT_BRIEF");
		static bool sourceBrowser = Config_getBool("SOURCE_BROWSER");
		return ((!briefDescription().isEmpty() && repeatBrief) \|\|
		!documentation().isEmpty() \|\|
		(sourceBrowser && getStartBodyLine()!=-1 && getBodyDef()));
		}

		// write the detailed description for this class
		void ClassDef::writeDetailedDescription(OutputList &ol, const QCString &/pageType/, bool exampleFlag,
		const QCString &title,const QCString &anchor)
		{
		if ((!briefDescription().isEmpty() && Config_getBool("REPEAT_BRIEF")) \|\|
		!documentation().isEmpty() \|\|
		(Config_getBool("SOURCE_BROWSER") && getStartBodyLine()!=-1 && getBodyDef()) \|\|
		exampleFlag)
		if (hasDetailedDescription() \|\| exampleFlag)
		{
		ol.pushGeneratorState();
		ol.disable(OutputGenerator::Html);
		@@ -1990,12 +1999,8 @@ void ClassDef::writeDocumentationContents(OutputList &ol,const QCString & /*page
		ol.endContents();
		}

		// write all documentation for this class
		void ClassDef::writeDocumentation(OutputList &ol)
		QCString ClassDef::title() const
		{
		static bool generateTreeView = Config_getBool("GENERATE_TREEVIEW");
		//static bool fortranOpt = Config_getBool("OPTIMIZE_FOR_FORTRAN");
		//static bool vhdlOpt = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
		QCString pageTitle;
		SrcLangExt lang = getLanguage();

		@@ -2027,6 +2032,16 @@ void ClassDef::writeDocumentation(OutputList &ol)
		m_impl->compType == Interface && getLanguage()==SrcLangExt_ObjC ? Class : m_impl->compType,
		m_impl->tempArgs != 0);
		}
		return pageTitle;
		}

		// write all documentation for this class
		void ClassDef::writeDocumentation(OutputList &ol)
		{
		static bool generateTreeView = Config_getBool("GENERATE_TREEVIEW");
		//static bool fortranOpt = Config_getBool("OPTIMIZE_FOR_FORTRAN");
		//static bool vhdlOpt = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
		QCString pageTitle = title();

		startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_ClassVisible,!generateTreeView);
		if (!generateTreeView)
		@@ -4723,4 +4738,8 @@ bool ClassDef::isExtension() const
		return b;
		}

		const ClassSDict *ClassDef::innerClasses() const
		{
		return m_impl->innerClasses;
		}

src/classdef.h

+8 −0

Original line number	Diff line number	Diff line
		@@ -125,6 +125,12 @@ class ClassDef : public Definition
		/** returns TRUE if this class has documentation */
		bool hasDocumentation() const;

		/** returns TRUE if this class has a brief description */
		bool hasBriefDescription() const;

		/** returns TRUE if this class has a non-empty detailed description */
		bool hasDetailedDescription() const;

		/** Returns the name as it is appears in the documentation */
		QCString displayName(bool includeScope=TRUE) const;

		@@ -301,6 +307,8 @@ class ClassDef : public Definition
		bool isJavaEnum() const;

		bool isGeneric() const;
		const ClassSDict *innerClasses() const;
		QCString title() const;

		//-----------------------------------------------------------------------------------
		// --- setters ----

Admin message