Doxygen
|
Generator for Man page output. 更多...
#include <mangen.h>
静态 Public 成员函数 | |
static void | init () |
Private 属性 | |
bool | m_firstCol = true |
bool | m_paragraph = true |
int | m_col = 0 |
bool | m_upperCase = false |
bool | m_insideTabbing = false |
bool | m_inHeader = false |
额外继承的成员函数 | |
Public 类型 继承自 OutputGenerator | |
enum | OutputType { Html, Latex, Man, RTF, XML, DEF, Perl, Docbook } |
Public 类型 继承自 BaseOutputDocInterface | |
enum | ParamListTypes { Param, RetVal, Exception } |
enum | SectionTypes { EnumValues, Examples } |
Protected 属性 继承自 OutputGenerator | |
TextStream | m_t |
ManGenerator::ManGenerator | ( | ) |
在文件 mangen.cpp 第 78 行定义.
ManGenerator::ManGenerator | ( | const ManGenerator & | g | ) |
在文件 mangen.cpp 第 82 行定义.
|
virtual |
在文件 mangen.cpp 第 97 行定义.
|
inlinevirtual |
实现了 CodeOutputInterface.
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 118 行定义.
引用了 clearSubDirs(), Config_getString , 以及 QCString::str().
void ManGenerator::clearBuffer | ( | ) |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 92 行定义.
|
virtual |
Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.
实现了 CodeOutputInterface.
在文件 mangen.cpp 第 317 行定义.
引用了 Config_getInt, QCString::data(), FALSE, QCString::isEmpty(), QCString::left(), m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, Doxygen::spaces, TRUE , 以及 writeUTF8Char().
被这些函数引用 endCompoundTemplateParams().
|
virtual |
Writes an ASCII string to the output. Converts characters that have A special meaning, like &
in html.
在文件 mangen.cpp 第 293 行定义.
引用了 QCString::data(), FALSE, QCString::isEmpty(), m_col, m_firstCol, m_paragraph , 以及 OutputGenerator::m_t.
被这些函数引用 startConstraintList(), startDescTable(), startExamples(), startMemberDocSimple(), startParamList(), writeCodeLink(), writeObjectLink() , 以及 writeString().
|
virtual |
|
inlinevirtual |
End a section of text displayed in bold face.
被这些函数引用 endQuickIndices(), startConstraintList(), startDescTable(), startExamples(), startParamList() , 以及 writeObjectLink().
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Ends a block of code
实现了 CodeOutputInterface.
在文件 mangen.cpp 第 406 行定义.
引用了 FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t , 以及 TRUE.
|
inlinevirtual |
Ends a line of code started with startCodeLine()
实现了 CodeOutputInterface.
|
inlinevirtual |
|
virtual |
|
virtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 722 行定义.
引用了 endEmphasis(), endItemListItem() , 以及 OutputGenerator::m_t.
|
virtual |
|
inlinevirtual |
|
virtual |
|
virtual |
Ends an item of a description list and starts the description itself: e.g. </dt>
in HTML.
在文件 mangen.cpp 第 516 行定义.
引用了 m_firstCol, OutputGenerator::m_t , 以及 TRUE.
|
inlinevirtual |
Ends a description list: e.g. </dl>
in HTML
|
virtual |
在文件 mangen.cpp 第 670 行定义.
引用了 endDescForItem().
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Ends a section of text displayed in italic.
被这些函数引用 endConstraintParam(), endConstraintType() , 以及 endQuickIndices().
|
virtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 172 行定义.
引用了 OutputGenerator::endPlainFile() , 以及 OutputGenerator::m_t.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 272 行定义.
引用了 FALSE, m_firstCol, m_paragraph, OutputGenerator::m_t, m_upperCase , 以及 TRUE.
被这些函数引用 endSection().
|
virtual |
|
virtual |
Ends a link started by startHtmlLink().
在文件 mangen.cpp 第 260 行定义.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inlinevirtual |
|
virtual |
Writes a list item for a bullet or enumerated list: e.g. </li>
in html
在文件 mangen.cpp 第 394 行定义.
被这些函数引用 endConstraintParam() , 以及 startQuickIndices().
|
virtual |
|
inlinevirtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 286 行定义.
引用了 FALSE, m_firstCol, m_paragraph, OutputGenerator::m_t , 以及 TRUE.
被这些函数引用 endSection().
|
virtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 559 行定义.
引用了 FALSE, m_firstCol, m_insideTabbing , 以及 OutputGenerator::m_t.
|
inlinevirtual |
|
inlinevirtual |
实现了 OutputGenerator.
引用了 m_col , 以及 OutputGenerator::m_t.
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
在文件 mangen.cpp 第 614 行定义.
引用了 ASSERT, endGroupHeader(), endMemberHeader(), FALSE, m_firstCol, m_inHeader, m_paragraph, OutputGenerator::m_t, Page, Paragraph, Section, Subsection, Subsubsection, TRUE , 以及 type().
|
inlinevirtual |
|
virtual |
在文件 mangen.cpp 第 468 行定义.
引用了 OutputGenerator::m_t.
|
virtual |
在文件 mangen.cpp 第 482 行定义.
引用了 OutputGenerator::m_t.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
在文件 mangen.cpp 第 380 行定义.
引用了 OutputGenerator::m_t.
实现了 OutputGenerator.
在文件 mangen.cpp 第 178 行定义.
引用了 Config_getString, dateToString(), FALSE, getExtension(), m_firstCol, m_inHeader, m_paragraph, OutputGenerator::m_t , 以及 TRUE.
|
inlinevirtual |
End a section of text displayed in typewriter style.
|
inlinevirtual |
|
static |
在文件 mangen.cpp 第 101 行定义.
引用了 Config_getString, createSubDirs(), Dir::exists(), getSubdir(), Dir::mkdir(), qPrint(), QCString::str() , 以及 term().
被这些函数引用 generateOutput().
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
void ManGenerator::newParagraph | ( | ) |
在文件 mangen.cpp 第 198 行定义.
引用了 m_firstCol, m_paragraph, OutputGenerator::m_t , 以及 TRUE.
被这些函数引用 startCodeFragment() , 以及 startProjectNumber().
ManGenerator & ManGenerator::operator= | ( | const ManGenerator & | g | ) |
在文件 mangen.cpp 第 86 行定义.
|
inlinevirtual |
实现了 CodeOutputInterface.
|
virtual |
|
inlinevirtual |
Changes the text font to bold face. The bold section ends with endBold()
引用了 m_firstCol, OutputGenerator::m_t , 以及 TRUE.
被这些函数引用 startConstraintList(), startDescList(), startDescTable(), startExamples(), startParamList(), startQuickIndices() , 以及 writeObjectLink().
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()
style | The kind of code fragment. |
实现了 CodeOutputInterface.
在文件 mangen.cpp 第 398 行定义.
引用了 FALSE, m_firstCol, m_paragraph, OutputGenerator::m_t, newParagraph() , 以及 TRUE.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 702 行定义.
引用了 docify(), endBold(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold() , 以及 TRUE.
|
virtual |
|
virtual |
|
inlinevirtual |
|
virtual |
在文件 mangen.cpp 第 502 行定义.
引用了 FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t , 以及 TRUE.
被这些函数引用 startDescTable().
|
virtual |
Starts an item of a description list: e.g. <dt>
in HTML.
在文件 mangen.cpp 第 495 行定义.
引用了 FALSE, m_firstCol , 以及 OutputGenerator::m_t.
void ManGenerator::startDescList | ( | SectionTypes | ) |
在文件 mangen.cpp 第 361 行定义.
引用了 FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold() , 以及 TRUE.
|
inlinevirtual |
Starts a description list: e.g. <dl>
in HTML Items are surrounded by startDescItem() and endDescItem()
|
virtual |
在文件 mangen.cpp 第 655 行定义.
引用了 docify(), endBold(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold(), startDescForItem() , 以及 TRUE.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
inlinevirtual |
Changes the text font to italic. The italic section ends with endEmphasis()
被这些函数引用 startConstraintParam(), startConstraintType() , 以及 startQuickIndices().
|
virtual |
在文件 mangen.cpp 第 637 行定义.
引用了 docify(), endBold(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold(), theTranslator, Translator::trExamples() , 以及 TRUE.
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 166 行定义.
引用了 buildFileName(), m_firstCol, OutputGenerator::startPlainFile() , 以及 TRUE.
|
inlinevirtual |
Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.
clsName | The category name. |
实现了 CodeOutputInterface.
|
inlinevirtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 264 行定义.
引用了 FALSE, m_firstCol, OutputGenerator::m_t, m_upperCase , 以及 TRUE.
被这些函数引用 startSection().
|
inlinevirtual |
|
virtual |
Starts a (link to an) URL found in the documentation.
url | The URL to link to. |
在文件 mangen.cpp 第 256 行定义.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inlinevirtual |
Start of a bullet list: e.g. <ul>
in html. startItemListItem() is Used for the bullet items.
|
virtual |
Writes a list item for a bullet or enumerated list: e.g. <li>
in html
在文件 mangen.cpp 第 385 行定义.
引用了 FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t , 以及 TRUE.
被这些函数引用 startConstraintParam() , 以及 startQuickIndices().
|
virtual |
|
inlinevirtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 415 行定义.
引用了 FALSE, m_firstCol, m_paragraph , 以及 OutputGenerator::m_t.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 768 行定义.
引用了 docify(), m_firstCol, OutputGenerator::m_t, theTranslator, Translator::trCompoundMembers() , 以及 Translator::trEnumerationValues().
|
virtual |
|
virtual |
|
virtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 280 行定义.
引用了 m_firstCol , 以及 OutputGenerator::m_t.
被这些函数引用 startSection().
实现了 OutputGenerator.
在文件 mangen.cpp 第 539 行定义.
引用了 FALSE, m_firstCol, m_insideTabbing , 以及 OutputGenerator::m_t.
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 551 行定义.
引用了 FALSE, m_firstCol, m_insideTabbing , 以及 OutputGenerator::m_t.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Starts a new paragraph
Starts a new paragraph
在文件 mangen.cpp 第 209 行定义.
引用了 m_firstCol, m_paragraph, OutputGenerator::m_t , 以及 TRUE.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
在文件 mangen.cpp 第 675 行定义.
引用了 docify(), endBold(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold() , 以及 TRUE.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
在文件 mangen.cpp 第 598 行定义.
引用了 ASSERT, FALSE, m_inHeader, Page, Paragraph, Section, startGroupHeader(), startMemberHeader(), Subsection, Subsubsection , 以及 type().
|
inlinevirtual |
|
virtual |
|
virtual |
在文件 mangen.cpp 第 474 行定义.
引用了 FALSE, m_firstCol, m_paragraph , 以及 OutputGenerator::m_t.
被这些函数引用 endMemberSubtitle().
|
inlinevirtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
Changes the text font to fixed size. The section ends with endTypewriter()
|
inlinevirtual |
|
virtual |
Writes a single ASCII character to the output. Converts characters that have a special meaning.
在文件 mangen.cpp 第 347 行定义.
引用了 FALSE, m_col, m_firstCol, m_paragraph , 以及 OutputGenerator::m_t.
|
inlinevirtual |
|
virtual |
Writes a link to an object in a code fragment.
type | The type of symbol, used for semantic syntax highlighting, may be Default is no info is available. |
ref | If this is non-zero, the object is to be found in an external documentation file. |
file | The file in which the object is located. |
anchor | The anchor uniquely identifying the object within the file. |
name | The text to display as a placeholder for the link. |
tooltip | The tooltip to display when the mouse is on the link. |
实现了 CodeOutputInterface.
在文件 mangen.cpp 第 248 行定义.
引用了 docify().
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 693 行定义.
引用了 DocNode::accept(), FALSE, Definition::getDefFileExtension(), m_firstCol, m_paragraph , 以及 OutputGenerator::m_t.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
Writes the line number of a source listing
ref | External reference (when imported from a tag file) |
file | The file part of the URL pointing to the docs. |
anchor | The anchor part of the URL pointing to the docs. |
lineNumber | The line number to write |
writeLineAnchor | Indicates if an anchor for the line number needs to be written |
实现了 CodeOutputInterface.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Writes a link to an object in the documentation.
ref | If this is non-zero, the object is to be found in an external documentation file. |
file | The file in which the object is located. |
anchor | The anchor uniquely identifying the object within the file. |
name | The text to display as a placeholder for the link. |
在文件 mangen.cpp 第 242 行定义.
引用了 docify(), endBold() , 以及 startBold().
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Writes an ASCII string to the output, without converting special characters.
在文件 mangen.cpp 第 224 行定义.
引用了 docify().
|
inlinevirtual |
|
virtual |
实现了 OutputGenerator.
在文件 mangen.cpp 第 487 行定义.
引用了 FALSE, m_firstCol, m_paragraph, OutputGenerator::m_t , 以及 TRUE.
|
inlinevirtual |
Writes a tool tip definition
id | unique identifier for the tooltip |
docInfo | Info about the symbol's documentation. |
decl | full declaration of the symbol (for functions) |
desc | brief description for the symbol |
defInfo | Info about the symbol's definition in the source code |
declInfo | Info about the symbol's declaration in the source code |
实现了 CodeOutputInterface.
|
private |
|
private |
被这些函数引用 codify(), docify(), endCodeFragment(), endConstraintDocs(), endDescItem(), endGroupHeader(), endInlineHeader(), endInlineMemberDoc(), endMemberDocSimple(), endMemberGroup(), endMemberGroupHeader(), endMemberHeader(), endMemberList(), endSection(), endTitleHead(), newParagraph(), startBold(), startCodeFragment(), startConstraintList(), startDescForItem(), startDescItem(), startDescList(), startDescTable(), startExamples(), startFile(), startGroupHeader(), startInlineHeader(), startItemListItem(), startMemberDoc(), startMemberDocSimple(), startMemberHeader(), startMemberItem(), startMemberList(), startParagraph(), startParamList(), startSubsection(), startSubsubsection(), startTitle(), writeChar(), writeDoc(), writeSplitBar() , 以及 writeSynopsis().
|
private |
被这些函数引用 endSection(), endTitleHead() , 以及 startSection().
|
private |
|
private |
被这些函数引用 codify(), docify(), endCodeFragment(), endGroupHeader(), endMemberHeader(), endSection(), endTitleHead(), newParagraph(), startCodeFragment(), startConstraintList(), startDescForItem(), startDescList(), startDescTable(), startExamples(), startItemListItem(), startMemberDoc(), startParagraph(), startParamList(), startSubsection(), startSubsubsection(), startTitle(), writeChar(), writeDoc() , 以及 writeSynopsis().
|
private |
被这些函数引用 endGroupHeader() , 以及 startGroupHeader().