Generator for Eclipse help files. 更多...

#include <eclipsehelp.h>

类 EclipseHelp 继承关系图:

EclipseHelp 的协作图:

Public 成员函数
	EclipseHelp ()

virtual	~EclipseHelp ()

virtual void	initialize ()
	Initialize the Eclipse generator 更多...

virtual void	finalize ()
	Finish generation of the Eclipse specific help files 更多...

virtual void	incContentsDepth ()
	Increase the level of content hierarchy 更多...

virtual void	decContentsDepth ()
	Decrease the level of content hierarchy 更多...

virtual void	addContentsItem (bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def)
	Add an item to the content 更多...

virtual void	addIndexItem (const Definition context, const MemberDef md, const QCString &sectionAnchor, const QCString &title)

virtual void	addIndexFile (const QCString &name)

virtual void	addImageFile (const QCString &name)

virtual void	addStyleSheetFile (const QCString &name)

Public 成员函数继承自 IndexIntf
virtual	~IndexIntf ()

Private 成员函数
	EclipseHelp (const EclipseHelp &)

EclipseHelp &	operator= (const EclipseHelp &)

void	indent ()

void	closedTag ()

void	openedTag ()

Private 属性
int	m_depth

bool	m_endtag

int	m_openTags

std::ofstream	m_tocstream

QCString	m_pathprefix

详细描述

Generator for Eclipse help files.

This class generates the Eclipse specific help files. These files can be used to generate a help plugin readable by the Eclipse IDE.

在文件 eclipsehelp.h 第 40 行定义.

构造及析构函数说明

◆ EclipseHelp() [1/2]

EclipseHelp::EclipseHelp ( )

在文件 eclipsehelp.cpp 第 21 行定义.

                          : m_depth(0), m_endtag(FALSE), m_openTags(0)
 {
 }

◆ ~EclipseHelp()

EclipseHelp::~EclipseHelp ( )

virtual

在文件 eclipsehelp.cpp 第 25 行定义.

26 {

27 }

◆ EclipseHelp() [2/2]

EclipseHelp::EclipseHelp ( const EclipseHelp & )

private

成员函数说明

◆ addContentsItem()

void EclipseHelp::addContentsItem	(	bool	isDir,
		const QCString &	name,
		const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		bool	separateIndex,
		bool	addToNavIndex,
		const Definition *	def
	)

virtual

Add an item to the content

参数

isDir	Flag whether the argument file is a directory or a file entry
name	Name of the item
ref	URL of the item
file	Name of a file which the item is defined in (without extension)
anchor	Name of an anchor of the item.
separateIndex	not used.
addToNavIndex	not used.
def	not used.

实现了 IndexIntf.

在文件 eclipsehelp.cpp 第 160 行定义.

 {
   // -- write the topic tag
   closedTag();
   if (!file.isEmpty())
   {
     switch (file[0]) // check for special markers (user defined URLs)
     {
       case '^':
         // URL not supported by eclipse toc.xml
         break;
  
       case '!':
         indent();
         m_tocstream << "<topic label=\"" << convertToXML(name) << "\"";
         m_tocstream << " href=\"" << convertToXML(m_pathprefix) << &file[1] << "\"";
         m_endtag = TRUE;
         break;
  
       default:
         indent();
         m_tocstream << "<topic label=\"" << convertToXML(name) << "\"";
         m_tocstream << " href=\"" << convertToXML(m_pathprefix)
                     << addHtmlExtensionIfMissing(file);
         if (!anchor.isEmpty())
         {
           m_tocstream << "#" << anchor;
         }
         m_tocstream << "\"";
         m_endtag = TRUE;
         break;
     }
   }
   else
   {
     indent();
     m_tocstream << "<topic label=\"" << convertToXML(name) << "\"";
     m_endtag = TRUE;
   }
 }

引用了 addHtmlExtensionIfMissing(), closedTag(), convertToXML(), indent(), QCString::isEmpty(), m_endtag, m_pathprefix, m_tocstream , 以及 TRUE.

◆ addImageFile()

void EclipseHelp::addImageFile ( const QCString & name )

virtual

实现了 IndexIntf.

在文件 eclipsehelp.cpp 第 221 行定义.

222 {

223 }

◆ addIndexFile()

void EclipseHelp::addIndexFile ( const QCString & name )

virtual

实现了 IndexIntf.

在文件 eclipsehelp.cpp 第 217 行定义.

218 {

219 }

◆ addIndexItem()

void EclipseHelp::addIndexItem	(	const Definition *	context,
		const MemberDef *	md,
		const QCString &	sectionAnchor,
		const QCString &	title
	)

virtual

实现了 IndexIntf.

在文件 eclipsehelp.cpp 第 209 行定义.

214 {

215 }

◆ addStyleSheetFile()

void EclipseHelp::addStyleSheetFile ( const QCString & name )

virtual

实现了 IndexIntf.

在文件 eclipsehelp.cpp 第 225 行定义.

226 {

227 }

◆ closedTag()

void EclipseHelp::closedTag ( )

private

在文件 eclipsehelp.cpp 第 38 行定义.

 {
   if (m_endtag)
   {
     m_tocstream << "/>\n";
     m_endtag = FALSE;
   }
 }

引用了 FALSE, m_endtag , 以及 m_tocstream.

被这些函数引用 addContentsItem(), decContentsDepth() , 以及 finalize().

◆ decContentsDepth()

void EclipseHelp::decContentsDepth ( )

virtual

Decrease the level of content hierarchy

It closes currently opened topic tag.

实现了 IndexIntf.

在文件 eclipsehelp.cpp 第 134 行定义.

 {
   // -- end of the opened topic
   closedTag();
   --m_depth;
  
   if (m_openTags==m_depth)
   {
     --m_openTags;
     indent();
     m_tocstream << "</topic>\n";
   }
 }

引用了 closedTag(), indent(), m_depth, m_openTags , 以及 m_tocstream.

◆ finalize()

void EclipseHelp::finalize ( )

virtual

Finish generation of the Eclipse specific help files

This method writes footers of the files and closes them.

参见: initialize()

实现了 IndexIntf.

在文件 eclipsehelp.cpp 第 95 行定义.

 {
   closedTag(); // -- close previous tag
  
   // -- write ending tag
   --m_depth;
   m_tocstream << "</toc>\n";
  
   // -- close the content file
   m_tocstream.close();
  
   QCString name = Config_getString(HTML_OUTPUT) + "/plugin.xml";
   std::ofstream t(name.str(),std::ofstream::out | std::ofstream::binary);
   if (t.is_open())
   {
     QCString docId = Config_getString(ECLIPSE_DOC_ID);
     t << "<plugin name=\""  << docId << "\" id=\"" << docId << "\"\n";
     t << "        version=\"1.0.0\" provider-name=\"Doxygen\">\n";
     t << "  <extension point=\"org.eclipse.help.toc\">\n";
     t << "    <toc file=\"toc.xml\" primary=\"true\" />\n";
     t << "  </extension>\n";
     t << "</plugin>\n";
   }
 }

引用了 closedTag(), Config_getString, m_depth, m_tocstream , 以及 QCString::str().

◆ incContentsDepth()

void EclipseHelp::incContentsDepth ( )

virtual

Increase the level of content hierarchy

实现了 IndexIntf.

在文件 eclipsehelp.cpp 第 123 行定义.

 {
   openedTag();
   ++m_depth;
 }

引用了 m_depth , 以及 openedTag().

◆ indent()

void EclipseHelp::indent ( )

private

在文件 eclipsehelp.cpp 第 29 行定义.

 {
   int i;
   for (i=0; i<m_depth; i++)
   {
     m_tocstream << "  ";
   }
 }

引用了 m_depth , 以及 m_tocstream.

被这些函数引用 addContentsItem() , 以及 decContentsDepth().

◆ initialize()

void EclipseHelp::initialize ( )

virtual

Initialize the Eclipse generator

This method opens the XML TOC file and writes headers of the files.

参见: finalize()

实现了 IndexIntf.

在文件 eclipsehelp.cpp 第 63 行定义.

 {
   // -- read path prefix from the configuration
   //m_pathprefix = Config_getString(ECLIPSE_PATHPREFIX);
   //if (m_pathprefix.isEmpty()) m_pathprefix = "html/";
  
   // -- open the contents file
   QCString name = Config_getString(HTML_OUTPUT) + "/toc.xml";
   m_tocstream.open(name.str(), std::ofstream::out | std::ofstream::binary);
   if (!m_tocstream.is_open())
   {
     term("Could not open file %s for writing\n", qPrint(name));
   }
  
   // -- write the opening tag
   QCString title = Config_getString(PROJECT_NAME);
   if (title.isEmpty())
   {
     title = "Doxygen generated documentation";
   }
   m_tocstream << "<toc label=\"" << convertToXML(title)
               << "\" topic=\"" << convertToXML(m_pathprefix)
               << "index" << Doxygen::htmlFileExtension << "\">\n";
   ++ m_depth;
 }

引用了 Config_getString, convertToXML(), Doxygen::htmlFileExtension, QCString::isEmpty(), m_depth, m_pathprefix, m_tocstream, qPrint(), QCString::str() , 以及 term().

◆ openedTag()

void EclipseHelp::openedTag ( )

private

在文件 eclipsehelp.cpp 第 47 行定义.

 {
   if (m_endtag)
   {
     m_tocstream << ">\n";
     m_endtag = FALSE;
     ++m_openTags;
   }
 }

引用了 FALSE, m_endtag, m_openTags , 以及 m_tocstream.

被这些函数引用 incContentsDepth().

◆ operator=()

EclipseHelp& EclipseHelp::operator= ( const EclipseHelp & )

private

类成员变量说明

◆ m_depth

int EclipseHelp::m_depth

private

在文件 eclipsehelp.h 第 61 行定义.

被这些函数引用 decContentsDepth(), finalize(), incContentsDepth(), indent() , 以及 initialize().

◆ m_endtag

bool EclipseHelp::m_endtag

private

在文件 eclipsehelp.h 第 62 行定义.

被这些函数引用 addContentsItem(), closedTag() , 以及 openedTag().

◆ m_openTags

int EclipseHelp::m_openTags

private

在文件 eclipsehelp.h 第 63 行定义.

被这些函数引用 decContentsDepth() , 以及 openedTag().

◆ m_pathprefix

QCString EclipseHelp::m_pathprefix

private

在文件 eclipsehelp.h 第 66 行定义.

被这些函数引用 addContentsItem() , 以及 initialize().

◆ m_tocstream

std::ofstream EclipseHelp::m_tocstream

private

在文件 eclipsehelp.h 第 65 行定义.

被这些函数引用 addContentsItem(), closedTag(), decContentsDepth(), finalize(), indent(), initialize() , 以及 openedTag().

该类的文档由以下文件生成:

src/eclipsehelp.h
src/eclipsehelp.cpp

Public 成员函数

Private 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ EclipseHelp() [1/2]

◆ ~EclipseHelp()

◆ EclipseHelp() [2/2]

成员函数说明

◆ addContentsItem()

◆ addImageFile()

◆ addIndexFile()

◆ addIndexItem()

◆ addStyleSheetFile()

◆ closedTag()

◆ decContentsDepth()

◆ finalize()

◆ incContentsDepth()

◆ indent()

◆ initialize()

◆ openedTag()

◆ operator=()

类成员变量说明

◆ m_depth

◆ m_endtag

◆ m_openTags

◆ m_pathprefix

◆ m_tocstream