ManGenerator Class Reference

#include <mangen.h>

Inheritance diagram for ManGenerator:

Public Member Functions
	ManGenerator ()
	~ManGenerator ()
void	enable ()
void	disable ()
void	enableIf (OutputType o)
void	disableIf (OutputType o)
void	disableIfNot (OutputType o)
bool	isEnabled (OutputType o)
OutputGenerator *	get (OutputType o)
void	writeDoc (DocNode *, Definition *, MemberDef *)
void	startFile (const char *name, const char *manName, const char *title)
void	writeSearchInfo ()
void	writeFooter (const char *)
void	endFile ()
void	clearBuffer ()
void	startIndexSection (IndexSections)
void	endIndexSection (IndexSections)
void	writePageLink (const char *, bool)
void	startProjectNumber ()
void	endProjectNumber ()
void	writeStyleInfo (int)
void	startTitleHead (const char *)
void	endTitleHead (const char *, const char *)
void	startTitle ()
void	endTitle ()
void	newParagraph ()
void	startParagraph ()
void	endParagraph ()
void	writeString (const char *text)
void	startIndexListItem ()
void	endIndexListItem ()
void	startIndexList ()
void	endIndexList ()
void	startIndexKey ()
void	endIndexKey ()
void	startIndexValue (bool)
void	endIndexValue (const char *, bool)
void	startItemList ()
void	endItemList ()
void	startIndexItem (const char *ref, const char *file)
void	endIndexItem (const char *ref, const char *file)
void	docify (const char *text)
void	codify (const char *text)
void	writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)
void	writeCodeLink (const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)
void	writeTooltip (const char *, const DocLinkInfo &, const char *, const char *, const SourceLinkInfo &, const SourceLinkInfo &)
void	startTextLink (const char *, const char *)
void	endTextLink ()
void	startHtmlLink (const char *url)
void	endHtmlLink ()
void	startTypewriter ()
void	endTypewriter ()
void	startGroupHeader (int)
void	endGroupHeader (int)
void	startMemberSections ()
void	endMemberSections ()
void	startHeaderSection ()
void	endHeaderSection ()
void	startMemberHeader (const char *)
void	endMemberHeader ()
void	insertMemberAlign (bool)
void	startMemberSubtitle ()
void	endMemberSubtitle ()
void	startItemListItem ()
void	endItemListItem ()
void	startMemberDocList ()
void	endMemberDocList ()
void	startMemberList ()
void	endMemberList ()
void	startInlineHeader ()
void	endInlineHeader ()
void	startAnonTypeScope (int)
void	endAnonTypeScope (int)
void	startMemberItem (const char *, int, const char *)
void	endMemberItem ()
void	startMemberTemplateParams ()
void	endMemberTemplateParams (const char *, const char *)
void	startMemberGroupHeader (bool)
void	endMemberGroupHeader ()
void	startMemberGroupDocs ()
void	endMemberGroupDocs ()
void	startMemberGroup ()
void	endMemberGroup (bool)
void	writeRuler ()
void	writeAnchor (const char *, const char *)
void	startCodeFragment ()
void	endCodeFragment ()
void	writeLineNumber (const char *, const char *, const char *, int l)
void	startCodeLine (bool)
void	endCodeLine ()
void	startEmphasis ()
void	endEmphasis ()
void	startBold ()
void	endBold ()
void	startDescription ()
void	endDescription ()
void	startDescItem ()
void	endDescItem ()
void	lineBreak (const char *)
void	writeChar (char c)
void	startMemberDoc (const char *, const char *, const char *, const char *, bool)
void	endMemberDoc (bool)
void	startDoxyAnchor (const char *, const char *, const char *, const char *, const char *)
void	endDoxyAnchor (const char *, const char *)
void	writeLatexSpacing ()
void	writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)
void	writeEndAnnoItem (const char *)
void	startSubsection ()
void	endSubsection ()
void	startSubsubsection ()
void	endSubsubsection ()
void	startCenter ()
void	endCenter ()
void	startSmall ()
void	endSmall ()
void	startMemberDescription (const char *, const char *)
void	endMemberDescription ()
void	startMemberDeclaration ()
void	endMemberDeclaration (const char *, const char *)
void	writeInheritedSectionTitle (const char *, const char *, const char *, const char *, const char *, const char *)
void	startDescList (SectionTypes)
void	endDescList ()
void	startSimpleSect (SectionTypes, const char *, const char *, const char *)
void	endSimpleSect ()
void	startParamList (ParamListTypes, const char *title)
void	endParamList ()
void	startDescForItem ()
void	endDescForItem ()
void	startSection (const char *, const char *, SectionInfo::SectionType)
void	endSection (const char *, SectionInfo::SectionType)
void	addIndexItem (const char *, const char *)
void	startIndent ()
void	endIndent ()
void	writeSynopsis ()
void	startClassDiagram ()
void	endClassDiagram (const ClassDiagram &, const char *, const char *)
void	startPageRef ()
void	endPageRef (const char *, const char *)
void	startQuickIndices ()
void	endQuickIndices ()
void	writeSplitBar (const char *)
void	writeNavigationPath (const char *)
void	writeLogo ()
void	writeQuickLinks (bool, HighlightedItem, const char *)
void	writeSummaryLink (const char *, const char *, const char *, bool)
void	startContents ()
void	endContents ()
void	writeNonBreakableSpace (int n)
void	startDescTable (const char *t)
void	endDescTable ()
void	startDescTableTitle ()
void	endDescTableTitle ()
void	startDescTableData ()
void	endDescTableData ()
void	startDotGraph ()
void	endDotGraph (const DotClassGraph &)
void	startInclDepGraph ()
void	endInclDepGraph (const DotInclDepGraph &)
void	startGroupCollaboration ()
void	endGroupCollaboration (const DotGroupCollaboration &)
void	startCallGraph ()
void	endCallGraph (const DotCallGraph &)
void	startDirDepGraph ()
void	endDirDepGraph (const DotDirDeps &)
void	writeGraphicalHierarchy (const DotGfxHierarchyTable &)
void	startTextBlock (bool)
void	endTextBlock (bool)
void	lastIndexPage ()
void	startMemberDocPrefixItem ()
void	endMemberDocPrefixItem ()
void	startMemberDocName (bool)
void	endMemberDocName ()
void	startParameterType (bool, const char *)
void	endParameterType ()
void	startParameterName (bool)
void	endParameterName (bool, bool, bool)
void	startParameterList (bool)
void	endParameterList ()
void	exceptionEntry (const char *, bool)
void	startFontClass (const char *)
void	endFontClass ()
void	startConstraintList (const char *)
void	startConstraintParam ()
void	endConstraintParam ()
void	startConstraintType ()
void	endConstraintType ()
void	startConstraintDocs ()
void	endConstraintDocs ()
void	endConstraintList ()
void	startMemberDocSimple ()
void	endMemberDocSimple ()
void	startInlineMemberType ()
void	endInlineMemberType ()
void	startInlineMemberName ()
void	endInlineMemberName ()
void	startInlineMemberDoc ()
void	endInlineMemberDoc ()
void	startLabels ()
void	writeLabel (const char *l, bool isLast)
void	endLabels ()
void	writeCodeAnchor (const char *)
void	setCurrentDoc (Definition *, const char *, bool)
void	addWord (const char *, bool)
Public Member Functions inherited from OutputGenerator
	OutputGenerator ()
virtual	~OutputGenerator ()
void	startPlainFile (const char *name)
void	endPlainFile ()
bool	isEnabled () const
void	pushGeneratorState ()
void	popGeneratorState ()
Public Member Functions inherited from BaseOutputDocInterface
virtual	~BaseOutputDocInterface ()
virtual bool	parseText (const QCString &s)
Public Member Functions inherited from CodeOutputInterface
virtual	~CodeOutputInterface ()

Static Public Member Functions
static void	init ()

Private Member Functions
	ManGenerator (const ManGenerator &g)
ManGenerator &	operator= (const ManGenerator &g)

Private Attributes
bool	firstCol
bool	paragraph
int	col
bool	upperCase
bool	insideTabbing
bool	inHeader

Additional Inherited Members
Public Types inherited from OutputGenerator
enum	OutputType {   Html, Latex, Man, RTF,   XML, DEF, Perl }
Public Types inherited from BaseOutputDocInterface
enum	ParamListTypes { Param, RetVal, Exception }
enum	SectionTypes { EnumValues, Examples }
Protected Attributes inherited from OutputGenerator
FTextStream	t
QFile *	file
QCString	fileName
QCString	dir
bool	active
QStack< bool > *	genStack

Detailed Description

Generator for Man page output.

Definition at line 26 of file mangen.h.

Constructor & Destructor Documentation

ManGenerator::ManGenerator

(

)

Definition at line 77 of file mangen.cpp.

                           : OutputGenerator()
{
  dir=Config_getString("MAN_OUTPUT") + "/" + getSubdir();
  firstCol=TRUE;
  paragraph=TRUE;
  col=0;
  upperCase=FALSE;
  insideTabbing=FALSE;
  inHeader=FALSE;
}

ManGenerator::~ManGenerator

(

)

Definition at line 88 of file mangen.cpp.

{
}

ManGenerator::ManGenerator ( const ManGenerator &  g )

private

Member Function Documentation

void ManGenerator::addIndexItem ( const char *  , const char *    )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 180 of file mangen.h.

{}

void ManGenerator::addWord ( const char *  , bool    )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 262 of file mangen.h.

{}

void ManGenerator::clearBuffer

(

)

void ManGenerator::codify ( const char *  s )

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.

Implements CodeOutputInterface.

Definition at line 323 of file mangen.cpp.

{
  //static char spaces[]="        ";
  if (str)
  {
    const char *p=str;
    char c;
    int spacesToNextTabStop;
    while (*p)
    {
      c=*p++;
      switch(c)
      {
        case '.':   t << "\\&."; break; // see  bug652277
        case '\t':  spacesToNextTabStop =
                          Config_getInt("TAB_SIZE") - (col%Config_getInt("TAB_SIZE"));
                    t << Doxygen::spaces.left(spacesToNextTabStop); 
                    col+=spacesToNextTabStop; 
                    break;
        case '\n':  t << "\n"; firstCol=TRUE; col=0; break;
        case '\\':  t << "\\"; col++; break;
        case '\"':  // no break!
        default:    p=writeUtf8Char(t,p-1); firstCol=FALSE; col++; break;
      }
    }
    //printf("%s",str);fflush(stdout);
  }
  paragraph=FALSE;
}

void ManGenerator::disable ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 37 of file mangen.h.

{ active=FALSE; }

void ManGenerator::disableIf ( OutputType  o )

inlinevirtual

Implements OutputGenerator.

Definition at line 39 of file mangen.h.

{ if (o==Man) disable(); }

void ManGenerator::disableIfNot ( OutputType  o )

inlinevirtual

Implements OutputGenerator.

Definition at line 40 of file mangen.h.

{ if (o!=Man) disable(); }

void ManGenerator::docify ( const char *  s )

virtual

Writes an ASCII string to the output. Converts characters that have A special meaning, like & in html.

Implements BaseOutputDocInterface.

Definition at line 299 of file mangen.cpp.

{
  if (str)
  {
    const char *p=str;
    char c=0;
    while ((c=*p++)) 
    {
      switch(c)
      {
        case '-':  t << "\\-"; break; // see  bug747780
        case '.':  t << "\\&."; break; // see  bug652277
        case '\\': t << "\\\\"; col++; break;
        case '\n': t << "\n"; col=0; break;
        case '\"':  c = '\''; // no break!
        default: t << c; col++; break;
      }
    }
    firstCol=(c=='\n');
    //printf("%s",str);fflush(stdout);
  }
  paragraph=FALSE;
}

void ManGenerator::enable ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 35 of file mangen.h.

    { if (genStack->top()) active=*genStack->top(); else active=TRUE; }

void ManGenerator::enableIf ( OutputType  o )

inlinevirtual

Implements OutputGenerator.

Definition at line 38 of file mangen.h.

{ if (o==Man) enable(); }

void ManGenerator::endAnonTypeScope ( int  indentLevel )

virtual

Implements OutputGenerator.

Definition at line 546 of file mangen.cpp.

{
  if (indentLevel==0)
  {
    insideTabbing=FALSE;
  }
}

void ManGenerator::endBold ( )

inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 140 of file mangen.h.

{ t << "\\fP"; firstCol=FALSE; }

void ManGenerator::endCallGraph ( const DotCallGraph &  )

inlinevirtual

Implements OutputGenerator.

Definition at line 214 of file mangen.h.

{}

void ManGenerator::endCenter ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 160 of file mangen.h.

{}

void ManGenerator::endClassDiagram ( const ClassDiagram &  , const char *  , const char *    )

inlinevirtual

Implements OutputGenerator.

Definition at line 185 of file mangen.h.

{}

void ManGenerator::endCodeFragment ( )

virtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 412 of file mangen.cpp.

{ 
  if (!firstCol) t << endl;
  t << ".fi" << endl; 
  firstCol=TRUE;
  paragraph=FALSE;
  col=0;
}

void ManGenerator::endCodeLine ( )

inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 136 of file mangen.h.

{ codify("\n"); col=0; }

void ManGenerator::endConstraintDocs ( )

virtual

Implements OutputGenerator.

Definition at line 740 of file mangen.cpp.

{
  t << endl; firstCol=TRUE;
}

void ManGenerator::endConstraintList ( )

virtual

Implements OutputGenerator.

Definition at line 745 of file mangen.cpp.

{
}

void ManGenerator::endConstraintParam ( )

virtual

Implements OutputGenerator.

Definition at line 719 of file mangen.cpp.

{
  endEmphasis();
  endItemListItem();
  t << " : ";
}

void ManGenerator::endConstraintType ( )

virtual

Implements OutputGenerator.

Definition at line 731 of file mangen.cpp.

{
  endEmphasis();
}

void ManGenerator::endContents ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 196 of file mangen.h.

{}

void ManGenerator::endDescForItem ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 528 of file mangen.cpp.

{
}

void ManGenerator::endDescItem ( )

virtual

Ends an item of a description list and starts the description itself: e.g. </dt> in HTML.

Implements BaseOutputDocInterface.

Definition at line 532 of file mangen.cpp.

{
  t << "\" 1c" << endl;
  firstCol=TRUE;
}

void ManGenerator::endDescList ( )

inline

Definition at line 170 of file mangen.h.

{}

void ManGenerator::endDescription ( )

inlinevirtual

Ends a description list: e.g. </dl> in HTML

Implements BaseOutputDocInterface.

Definition at line 142 of file mangen.h.

{}

void ManGenerator::endDescTable ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 201 of file mangen.h.

{ endDescForItem(); endSimpleSect(); }

void ManGenerator::endDescTableData ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 205 of file mangen.h.

{}

void ManGenerator::endDescTableTitle ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 203 of file mangen.h.

{ endEmphasis(); endBold(); }

void ManGenerator::endDirDepGraph ( const DotDirDeps &  )

inlinevirtual

Implements OutputGenerator.

Definition at line 216 of file mangen.h.

{}

void ManGenerator::endDotGraph ( const DotClassGraph &  )

inlinevirtual

Implements OutputGenerator.

Definition at line 208 of file mangen.h.

{}

void ManGenerator::endDoxyAnchor ( const char *  , const char *    )

inlinevirtual

Implements OutputGenerator.

Definition at line 150 of file mangen.h.

{}

void ManGenerator::endEmphasis ( )

inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 138 of file mangen.h.

{ t << "\\fP"; firstCol=FALSE; }

void ManGenerator::endFile ( )

virtual

Implements OutputGenerator.

Definition at line 174 of file mangen.cpp.

{
  t << endl;
  endPlainFile();
}

void ManGenerator::endFontClass ( )

inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 236 of file mangen.h.

{}

void ManGenerator::endGroupCollaboration ( const DotGroupCollaboration &  )

inlinevirtual

Implements OutputGenerator.

Definition at line 212 of file mangen.h.

{}

void ManGenerator::endGroupHeader ( int  )

virtual

Implements OutputGenerator.

Definition at line 278 of file mangen.cpp.

{
  t << "\"\n.PP " << endl;
  firstCol=TRUE;
  paragraph=TRUE;
  upperCase=FALSE;
}

void ManGenerator::endHeaderSection ( )

virtual

Implements OutputGenerator.

Definition at line 830 of file mangen.cpp.

{
}

void ManGenerator::endHtmlLink ( )

virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 261 of file mangen.cpp.

{
}

void ManGenerator::endInclDepGraph ( const DotInclDepGraph &  )

inlinevirtual

Implements OutputGenerator.

Definition at line 210 of file mangen.h.

{}

void ManGenerator::endIndent ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 182 of file mangen.h.

{}

void ManGenerator::endIndexItem ( const char *  ref, const char *  file  )

virtual

Implements OutputGenerator.

Definition at line 235 of file mangen.cpp.

{
}

void ManGenerator::endIndexKey ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 73 of file mangen.h.

{} 

void ManGenerator::endIndexList ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 71 of file mangen.h.

{ newParagraph(); } 

void ManGenerator::endIndexListItem ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 69 of file mangen.h.

{}

void ManGenerator::endIndexSection ( IndexSections  )

inlinevirtual

Implements OutputGenerator.

Definition at line 54 of file mangen.h.

{}

void ManGenerator::endIndexValue ( const char *  , bool    )

inlinevirtual

Implements OutputGenerator.

Definition at line 75 of file mangen.h.

{} 

void ManGenerator::endInlineHeader ( )

virtual

Implements OutputGenerator.

Definition at line 759 of file mangen.cpp.

{
  t << "\\fP\"" << endl << ".in +1c" << endl;
  firstCol = FALSE;
}

void ManGenerator::endInlineMemberDoc ( )

virtual

Implements OutputGenerator.

Definition at line 808 of file mangen.cpp.

{
  if (!firstCol) t << endl;
  t << ".br" << endl;
  t << ".PP" << endl;
  firstCol=TRUE;
}

void ManGenerator::endInlineMemberName ( )

virtual

Implements OutputGenerator.

Definition at line 799 of file mangen.cpp.

{
  t << "\\fP ";
}

void ManGenerator::endInlineMemberType ( )

virtual

Implements OutputGenerator.

Definition at line 789 of file mangen.cpp.

{
  t << " ";
}

void ManGenerator::endItemList ( )

inlinevirtual

Ends a bullet list: e.g. </ul> in html

Implements BaseOutputDocInterface.

Definition at line 77 of file mangen.h.

{ newParagraph(); }

void ManGenerator::endItemListItem ( )

virtual

Writes a list item for a bullet or enumerated list: e.g. </li> in html

Implements BaseOutputDocInterface.

Definition at line 400 of file mangen.cpp.

{
}

void ManGenerator::endLabels ( )

virtual

Implements OutputGenerator.

Definition at line 826 of file mangen.cpp.

{
}

void ManGenerator::endMemberDeclaration ( const char *  , const char *    )

inlinevirtual

Implements OutputGenerator.

Definition at line 166 of file mangen.h.

{}

void ManGenerator::endMemberDescription ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 164 of file mangen.h.

{ t << "\\fP\""; firstCol=FALSE; }

void ManGenerator::endMemberDoc ( bool  )

virtual

Implements OutputGenerator.

Definition at line 465 of file mangen.cpp.

{
    t << "\"\n";
}

void ManGenerator::endMemberDocList ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 111 of file mangen.h.

{}

void ManGenerator::endMemberDocName ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 226 of file mangen.h.

{}

void ManGenerator::endMemberDocPrefixItem ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 224 of file mangen.h.

{}

void ManGenerator::endMemberDocSimple ( )

virtual

Implements OutputGenerator.

Definition at line 777 of file mangen.cpp.

{
  if (!firstCol) t << endl;
  t << ".RE" << endl;
  t << ".PP" << endl;
  firstCol=TRUE;
}

void ManGenerator::endMemberGroup ( bool  )

virtual

Implements OutputGenerator.

Definition at line 608 of file mangen.cpp.

{
  t << "\n.in -1c";
  firstCol=FALSE;
}

void ManGenerator::endMemberGroupDocs ( )

virtual

Implements OutputGenerator.

Definition at line 598 of file mangen.cpp.

{
  t << "\n.PP";
}

void ManGenerator::endMemberGroupHeader ( )

virtual

Implements OutputGenerator.

Definition at line 588 of file mangen.cpp.

{
  t << "\\fP\"\n.br\n";
  firstCol=TRUE;
}

void ManGenerator::endMemberHeader ( )

virtual

Implements OutputGenerator.

Definition at line 292 of file mangen.cpp.

{
  t << "\"\n";
  firstCol=TRUE;
  paragraph=FALSE;
}

void ManGenerator::endMemberItem ( )

virtual

Implements OutputGenerator.

Definition at line 562 of file mangen.cpp.

{ 
  t << "\"\n.br"; 
}

void ManGenerator::endMemberList ( )

virtual

Implements OutputGenerator.

Definition at line 575 of file mangen.cpp.

{ 
  if (!insideTabbing)
  {
    t << "\n.in -1c"; firstCol=FALSE; 
  }
}

void ManGenerator::endMemberSections ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 99 of file mangen.h.

{}

void ManGenerator::endMemberSubtitle ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 106 of file mangen.h.

{}

void ManGenerator::endMemberTemplateParams ( const char *  , const char *    )

inlinevirtual

Implements OutputGenerator.

Definition at line 121 of file mangen.h.

{}

void ManGenerator::endPageRef ( const char *  , const char *    )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 187 of file mangen.h.

{}

void ManGenerator::endParagraph ( )

virtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 222 of file mangen.cpp.

{
}

void ManGenerator::endParameterList ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 232 of file mangen.h.

{}

void ManGenerator::endParameterName ( bool  , bool  , bool    )

inlinevirtual

Implements OutputGenerator.

Definition at line 230 of file mangen.h.

{}

void ManGenerator::endParameterType ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 228 of file mangen.h.

{}

void ManGenerator::endParamList ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 686 of file mangen.cpp.

{
}

void ManGenerator::endProjectNumber ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 57 of file mangen.h.

{}

void ManGenerator::endQuickIndices ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 189 of file mangen.h.

{}

void ManGenerator::endSection ( const char *  , SectionInfo::SectionType  type  )

virtual

Implements BaseOutputDocInterface.

Definition at line 630 of file mangen.cpp.

{
  if( !inHeader )
  {
    switch(type)
    {
      case SectionInfo::Page:          endGroupHeader(0); break;
      case SectionInfo::Section:       endGroupHeader(0); break;
      case SectionInfo::Subsection:    endMemberHeader(); break;
      case SectionInfo::Subsubsection: endMemberHeader(); break;
      case SectionInfo::Paragraph:     endMemberHeader(); break;
      default: ASSERT(0); break;
    }
  }
  else
  {
    t << "\n";
    firstCol=TRUE;
    paragraph=FALSE;
    inHeader=FALSE;
  }
}

void ManGenerator::endSimpleSect ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 668 of file mangen.cpp.

{
}

void ManGenerator::endSmall ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 162 of file mangen.h.

{}

void ManGenerator::endSubsection ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 478 of file mangen.cpp.

{
  t << "\"";
}

void ManGenerator::endSubsubsection ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 492 of file mangen.cpp.

{
  t << "\"";
}

void ManGenerator::endTextBlock ( bool  )

inlinevirtual

Implements OutputGenerator.

Definition at line 220 of file mangen.h.

{}

void ManGenerator::endTextLink ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 91 of file mangen.h.

{}

void ManGenerator::endTitle ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 386 of file mangen.cpp.

{
    t << "\"";
}

void ManGenerator::endTitleHead ( const char *  , const char *  name  )

virtual

Implements OutputGenerator.

Definition at line 180 of file mangen.cpp.

{
  t << ".TH \"" << name << "\" " << getExtension() << " \"" 
    << dateToString(FALSE) << "\" \"";
  if (!Config_getString("PROJECT_NUMBER").isEmpty())
    t << "Version " << Config_getString("PROJECT_NUMBER") << "\" \"";
  if (Config_getString("PROJECT_NAME").isEmpty()) 
    t << "Doxygen";
  else
    t << Config_getString("PROJECT_NAME");
  t << "\" \\\" -*- nroff -*-" << endl;
  t << ".ad l" << endl;
  t << ".nh" << endl;
  t << ".SH NAME" << endl;
  t << name << " \\- ";
  firstCol=FALSE;
  paragraph=TRUE;
  inHeader=TRUE;
}

void ManGenerator::endTypewriter ( )

inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 95 of file mangen.h.

{ t << "\\fP"; firstCol=FALSE; }

void ManGenerator::exceptionEntry ( const char *  , bool    )

inlinevirtual

Implements OutputGenerator.

Definition at line 233 of file mangen.h.

{}

OutputGenerator* ManGenerator::get ( OutputType  o )

inlinevirtual

Implements OutputGenerator.

Definition at line 42 of file mangen.h.

{ return (o==Man) ? this : 0; }

void ManGenerator::init ( )

static

Definition at line 108 of file mangen.cpp.

{
  QCString &manOutput = Config_getString("MAN_OUTPUT");
  
  QDir d(manOutput);
  if (!d.exists() && !d.mkdir(manOutput))
  {
    err("Could not create output directory %s\n",manOutput.data());
    exit(1);
  }
  d.setPath(manOutput + "/" + getSubdir());
  if (!d.exists() && !d.mkdir(manOutput + "/" + getSubdir()))
  {
    err("Could not create output directory %s/%s\n",manOutput.data(), getSubdir().data());
    exit(1);
  }
  createSubDirs(d);
}

void ManGenerator::insertMemberAlign ( bool  )

inlinevirtual

Implements OutputGenerator.

Definition at line 104 of file mangen.h.

{}

bool ManGenerator::isEnabled ( OutputType  o )

inlinevirtual

Implements OutputGenerator.

Definition at line 41 of file mangen.h.

{ return (o==Man && active); } 

void ManGenerator::lastIndexPage ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 221 of file mangen.h.

{}

void ManGenerator::lineBreak ( const char *  )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 145 of file mangen.h.

{ t << "\n.br" << endl; }

void ManGenerator::newParagraph

(

)

Definition at line 200 of file mangen.cpp.

{
  if (!paragraph)
  {
    if (!firstCol) t << endl;
    t << ".PP" << endl;
    firstCol=TRUE;
  }
  paragraph=TRUE;
}

ManGenerator& ManGenerator::operator= ( const ManGenerator &  g )

private

void ManGenerator::setCurrentDoc ( Definition *  , const char *  , bool    )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 261 of file mangen.h.

{}

void ManGenerator::startAnonTypeScope ( int  indentLevel )

virtual

Implements OutputGenerator.

Definition at line 538 of file mangen.cpp.

{
  if (indentLevel==0)
  {
    insideTabbing=TRUE;
  }
}

void ManGenerator::startBold ( )

inlinevirtual

Changes the text font to bold face. The bold section ends with endBold()

Implements BaseOutputDocInterface.

Definition at line 139 of file mangen.h.

{ t << "\\fB"; firstCol=FALSE; }

void ManGenerator::startCallGraph ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 213 of file mangen.h.

{}

void ManGenerator::startCenter ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 159 of file mangen.h.

{}

void ManGenerator::startClassDiagram ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 184 of file mangen.h.

{}

void ManGenerator::startCodeFragment ( )

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()

Implements BaseOutputDocInterface.

Definition at line 404 of file mangen.cpp.

{ 
  newParagraph();
  t << ".nf" << endl; 
  firstCol=TRUE;
  paragraph=FALSE;
}

void ManGenerator::startCodeLine ( bool  )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 135 of file mangen.h.

{}

void ManGenerator::startConstraintDocs ( )

virtual

Implements OutputGenerator.

Definition at line 736 of file mangen.cpp.

{
}

void ManGenerator::startConstraintList ( const char *  header )

virtual

Implements OutputGenerator.

Definition at line 699 of file mangen.cpp.

{
  if (!firstCol) 
  { t << endl << ".PP" << endl; 
    firstCol=TRUE; paragraph=TRUE; 
    col=0;
  }
  paragraph=FALSE;
  startBold();
  docify(header);
  endBold();
  paragraph=TRUE;
}

void ManGenerator::startConstraintParam ( )

virtual

Implements OutputGenerator.

Definition at line 713 of file mangen.cpp.

{
  startItemListItem();
  startEmphasis();
}

void ManGenerator::startConstraintType ( )

virtual

Implements OutputGenerator.

Definition at line 726 of file mangen.cpp.

{
  startEmphasis();
}

void ManGenerator::startContents ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 195 of file mangen.h.

{}

void ManGenerator::startDescForItem ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 518 of file mangen.cpp.

{
  if (!firstCol) t << endl;
  if (!paragraph) t << ".in -1c" << endl;
  t << ".in +1c" << endl;
  firstCol=TRUE;
  paragraph=FALSE;
  col=0;
}

void ManGenerator::startDescItem ( )

virtual

Starts an item of a description list: e.g. <dt> in HTML.

Implements BaseOutputDocInterface.

Definition at line 505 of file mangen.cpp.

{
  if (!firstCol) t << endl;
  t << ".IP \"";
  firstCol=FALSE;
}

void ManGenerator::startDescList

(

SectionTypes

)

Definition at line 367 of file mangen.cpp.

{
  if (!firstCol) 
  { t << endl << ".PP" << endl; 
    firstCol=TRUE; paragraph=TRUE; 
    col=0;
  }
  paragraph=FALSE;
  startBold();
}

void ManGenerator::startDescription ( )

inlinevirtual

Starts a description list: e.g. <dl> in HTML Items are surrounded by startDescItem() and endDescItem()

Implements BaseOutputDocInterface.

Definition at line 141 of file mangen.h.

{}

void ManGenerator::startDescTable ( const char *  t )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 199 of file mangen.h.

    { startSimpleSect(EnumValues,0,0,t); startDescForItem(); }

void ManGenerator::startDescTableData ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 204 of file mangen.h.

{ t << endl; firstCol=TRUE; }

void ManGenerator::startDescTableTitle ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 202 of file mangen.h.

{ startItemListItem(); startBold(); startEmphasis(); endItemListItem(); }

void ManGenerator::startDirDepGraph ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 215 of file mangen.h.

{} 

void ManGenerator::startDotGraph ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 207 of file mangen.h.

{}

void ManGenerator::startDoxyAnchor ( const char *  , const char *  manName, const char *  , const char *  name, const char *    )

virtual

Implements OutputGenerator.

Definition at line 429 of file mangen.cpp.

{
    // something to be done?
    if( !Config_getBool("MAN_LINKS") ) 
    {
        return; // no
    }

    // the name of the link file is derived from the name of the anchor:
    // - truncate after an (optional) ::
    QCString baseName = name;
    int i=baseName.findRev("::");
    if (i!=-1) baseName=baseName.right(baseName.length()-i-2);

    //printf("Converting man link '%s'->'%s'->'%s'\n",
    //       name,baseName.data(),buildFileName(baseName).data());
    
    // - remove dangerous characters and append suffix, then add dir prefix
    QCString fileName=dir+"/"+buildFileName( baseName );
    QFile linkfile( fileName );
    // - only create file if it doesn't exist already
    if ( !linkfile.open( IO_ReadOnly ) ) 
    {
        if ( linkfile.open( IO_WriteOnly ) ) 
        {
              FTextStream linkstream;
              linkstream.setDevice(&linkfile);
              //linkstream.setEncoding(QTextStream::UnicodeUTF8);
              linkstream << ".so " << getSubdir() << "/" << buildFileName( manName ) << endl;
        }
    }
    linkfile.close();
}

void ManGenerator::startEmphasis ( )

inlinevirtual

Changes the text font to italic. The italic section ends with endEmphasis()

Implements BaseOutputDocInterface.

Definition at line 137 of file mangen.h.

{ t << "\\fI"; firstCol=FALSE; }

void ManGenerator::startFile ( const char *  name, const char *  manName, const char *  title  )

virtual

Implements OutputGenerator.

Definition at line 168 of file mangen.cpp.

{
  startPlainFile( buildFileName( manName ) );
  firstCol=TRUE;
}

void ManGenerator::startFontClass ( const char *  clsName )

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'.

Parameters

clsName

The category name.

Implements CodeOutputInterface.

Definition at line 235 of file mangen.h.

{}

void ManGenerator::startGroupCollaboration ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 211 of file mangen.h.

{}

void ManGenerator::startGroupHeader ( int  )

virtual

Implements OutputGenerator.

Definition at line 270 of file mangen.cpp.

{
  if (!firstCol) t << endl;
  t << ".SH \"";
  upperCase=TRUE;
  firstCol=FALSE;
}

void ManGenerator::startHeaderSection ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 100 of file mangen.h.

{}

void ManGenerator::startHtmlLink ( const char *  url )

virtual

Starts a (link to an) URL found in the documentation.

Parameters

url	The URL to link to.

Implements BaseOutputDocInterface.

Definition at line 257 of file mangen.cpp.

{
}

void ManGenerator::startInclDepGraph ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 209 of file mangen.h.

{}

void ManGenerator::startIndent ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 181 of file mangen.h.

{}

void ManGenerator::startIndexItem ( const char *  ref, const char *  file  )

virtual

Implements OutputGenerator.

Definition at line 231 of file mangen.cpp.

{
}

void ManGenerator::startIndexKey ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 72 of file mangen.h.

{}

void ManGenerator::startIndexList ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 70 of file mangen.h.

{}

void ManGenerator::startIndexListItem ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 68 of file mangen.h.

{}

void ManGenerator::startIndexSection ( IndexSections  )

inlinevirtual

Implements OutputGenerator.

Definition at line 53 of file mangen.h.

{}

void ManGenerator::startIndexValue ( bool  )

inlinevirtual

Implements OutputGenerator.

Definition at line 74 of file mangen.h.

{}

void ManGenerator::startInlineHeader ( )

virtual

Implements OutputGenerator.

Definition at line 750 of file mangen.cpp.

{
  if (!firstCol) 
  {
    t << endl << ".PP" << endl << ".in -1c" << endl;
  }
  t << ".RI \"\\fB"; 
}

void ManGenerator::startInlineMemberDoc ( )

virtual

Implements OutputGenerator.

Definition at line 804 of file mangen.cpp.

{
}

void ManGenerator::startInlineMemberName ( )

virtual

Implements OutputGenerator.

Definition at line 794 of file mangen.cpp.

{
  t << "\\fI";
}

void ManGenerator::startInlineMemberType ( )

virtual

Implements OutputGenerator.

Definition at line 785 of file mangen.cpp.

{
}

void ManGenerator::startItemList ( )

inlinevirtual

Start of a bullet list: e.g. <ul> in html. startItemListItem() is Used for the bullet items.

Implements BaseOutputDocInterface.

Definition at line 76 of file mangen.h.

{}

void ManGenerator::startItemListItem ( )

virtual

Writes a list item for a bullet or enumerated list: e.g. <li> in html

Implements BaseOutputDocInterface.

Definition at line 391 of file mangen.cpp.

{ 
  if (!firstCol) t << endl; 
  t << ".TP" << endl; 
  firstCol=TRUE;
  paragraph=FALSE;
  col=0;
} 

void ManGenerator::startLabels ( )

virtual

Implements OutputGenerator.

Definition at line 816 of file mangen.cpp.

{
}

void ManGenerator::startMemberDeclaration ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 165 of file mangen.h.

{} 

void ManGenerator::startMemberDescription ( const char *  , const char *    )

inlinevirtual

Implements OutputGenerator.

Definition at line 163 of file mangen.h.

{ t << "\n.RI \"\\fI"; firstCol=FALSE; }

void ManGenerator::startMemberDoc ( const char *  , const char *  , const char *  , const char *  , bool    )

virtual

Implements OutputGenerator.

Definition at line 421 of file mangen.cpp.

{ 
  if (!firstCol) t << endl;
  t << ".SS \""; 
  firstCol=FALSE;
  paragraph=FALSE;
}

void ManGenerator::startMemberDocList ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 110 of file mangen.h.

{}

void ManGenerator::startMemberDocName ( bool  )

inlinevirtual

Implements OutputGenerator.

Definition at line 225 of file mangen.h.

{}

void ManGenerator::startMemberDocPrefixItem ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 223 of file mangen.h.

{}

void ManGenerator::startMemberDocSimple ( )

virtual

Implements OutputGenerator.

Definition at line 765 of file mangen.cpp.

{
  if (!firstCol) 
  {
    t << endl << ".PP" << endl;
  }
  t << "\\fB";
  docify(theTranslator->trCompoundMembers());
  t << ":\\fP" << endl;
  t << ".RS 4" << endl;
}

void ManGenerator::startMemberGroup ( )

virtual

Implements OutputGenerator.

Definition at line 603 of file mangen.cpp.

{
  t << "\n.in +1c";
}

void ManGenerator::startMemberGroupDocs ( )

virtual

Implements OutputGenerator.

Definition at line 594 of file mangen.cpp.

{
}

void ManGenerator::startMemberGroupHeader ( bool  )

virtual

Implements OutputGenerator.

Definition at line 583 of file mangen.cpp.

{
  t << "\n.PP\n.RI \"\\fB";
}

void ManGenerator::startMemberHeader ( const char *  )

virtual

Implements OutputGenerator.

Definition at line 286 of file mangen.cpp.

{
  if (!firstCol) t << endl;
  t << ".SS \"";
}

void ManGenerator::startMemberItem ( const char *  , int  , const char *    )

virtual

Implements OutputGenerator.

Definition at line 555 of file mangen.cpp.

{ 
  if (firstCol && !insideTabbing) t << ".in +1c\n";
  t << "\n.ti -1c\n.RI \""; 
  firstCol=FALSE;
}

void ManGenerator::startMemberList ( )

virtual

Implements OutputGenerator.

Definition at line 567 of file mangen.cpp.

{ 
  if (!insideTabbing)
  {
    t << "\n.in +1c"; firstCol=FALSE; 
  }
}

void ManGenerator::startMemberSections ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 98 of file mangen.h.

{}

void ManGenerator::startMemberSubtitle ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 105 of file mangen.h.

{}

void ManGenerator::startMemberTemplateParams ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 120 of file mangen.h.

{}

void ManGenerator::startPageRef ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 186 of file mangen.h.

{}

void ManGenerator::startParagraph ( )

virtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 211 of file mangen.cpp.

{
  if (!paragraph)
  {
    if (!firstCol) t << endl;
    t << ".PP" << endl;
    firstCol=TRUE;
  }
  paragraph=TRUE;
}

void ManGenerator::startParameterList ( bool  )

inlinevirtual

Implements OutputGenerator.

Definition at line 231 of file mangen.h.

{}

void ManGenerator::startParameterName ( bool  )

inlinevirtual

Implements OutputGenerator.

Definition at line 229 of file mangen.h.

{}

void ManGenerator::startParameterType ( bool  , const char *    )

inlinevirtual

Implements OutputGenerator.

Definition at line 227 of file mangen.h.

{}

void ManGenerator::startParamList ( ParamListTypes  , const char *  title  )

virtual

Implements BaseOutputDocInterface.

Definition at line 672 of file mangen.cpp.

{
  if (!firstCol) 
  { t << endl << ".PP" << endl; 
    firstCol=TRUE; paragraph=TRUE; 
    col=0;
  }
  paragraph=FALSE;
  startBold();
  docify(title);
  endBold();
  paragraph=TRUE;
}

void ManGenerator::startProjectNumber ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 56 of file mangen.h.

{}

void ManGenerator::startQuickIndices ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 188 of file mangen.h.

{}

void ManGenerator::startSection ( const char *  , const char *  , SectionInfo::SectionType  type  )

virtual

Implements BaseOutputDocInterface.

Definition at line 614 of file mangen.cpp.

{
  if( !inHeader ) 
  {
    switch(type)
    {
      case SectionInfo::Page:          startGroupHeader(FALSE); break;
      case SectionInfo::Section:       startGroupHeader(FALSE); break;
      case SectionInfo::Subsection:    startMemberHeader(0); break;
      case SectionInfo::Subsubsection: startMemberHeader(0); break;
      case SectionInfo::Paragraph:     startMemberHeader(0); break;
      default: ASSERT(0); break;
    }
  }
}

void ManGenerator::startSimpleSect ( SectionTypes  , const char *  , const char *  , const char *  title  )

virtual

Implements BaseOutputDocInterface.

Definition at line 653 of file mangen.cpp.

{
  if (!firstCol) 
  { t << endl << ".PP" << endl; 
    firstCol=TRUE; paragraph=TRUE; 
    col=0;
  }
  paragraph=FALSE;
  startBold();
  docify(title);
  endBold();
  paragraph=TRUE;
}

void ManGenerator::startSmall ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 161 of file mangen.h.

{}

void ManGenerator::startSubsection ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 470 of file mangen.cpp.

{ 
  if (!firstCol) t << endl;
  t << ".SS \""; 
  firstCol=FALSE;
  paragraph=FALSE;
}

void ManGenerator::startSubsubsection ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 484 of file mangen.cpp.

{ 
  if (!firstCol) t << endl;
  t << "\n.SS \""; 
  firstCol=FALSE;
  paragraph=FALSE;
}

void ManGenerator::startTextBlock ( bool  )

inlinevirtual

Implements OutputGenerator.

Definition at line 219 of file mangen.h.

{}

void ManGenerator::startTextLink ( const char *  , const char *    )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 90 of file mangen.h.

{}

void ManGenerator::startTitle ( )

virtual

Implements BaseOutputDocInterface.

Definition at line 378 of file mangen.cpp.

{ 
  if (!firstCol) t << endl; 
  t << ".SH \""; 
  firstCol=FALSE;
  paragraph=FALSE;
}

void ManGenerator::startTitleHead ( const char *  )

inlinevirtual

Implements OutputGenerator.

Definition at line 59 of file mangen.h.

{}

void ManGenerator::startTypewriter ( )

inlinevirtual

Changes the text font to fixed size. The section ends with endTypewriter()

Implements BaseOutputDocInterface.

Definition at line 94 of file mangen.h.

{ t << "\\fC"; firstCol=FALSE; }

void ManGenerator::writeAnchor ( const char *  , const char *    )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 131 of file mangen.h.

{}

void ManGenerator::writeChar ( char  c )

virtual

Writes a single ASCII character to the output. Converts characters that have a special meaning.

Implements BaseOutputDocInterface.

Definition at line 353 of file mangen.cpp.

{
  firstCol=(c=='\n');
  if (firstCol) col=0; else col++;
  switch (c)
  {
    case '\\': t << "\\\\"; break;
  case '\"': c = '\''; // no break!
    default:   t << c; break;
  }
  //printf("%c",c);fflush(stdout);
  paragraph=FALSE;
}

void ManGenerator::writeCodeAnchor ( const char *  name )

inlinevirtual

Write an anchor to a source listing.

Parameters

name	The name of the anchor.

Implements CodeOutputInterface.

Definition at line 260 of file mangen.h.

{}

void ManGenerator::writeCodeLink ( const char *  ref, const char *  file, const char *  anchor, const char *  name, const char *  tooltip  )

virtual

Writes a link to an object in a code fragment.

Parameters

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.

Implements CodeOutputInterface.

Definition at line 250 of file mangen.cpp.

{
  docify(name);
}

void ManGenerator::writeDoc ( DocNode *  n, Definition *  ctx, MemberDef *    )

virtual

Implements OutputGenerator.

Definition at line 690 of file mangen.cpp.

{
  ManDocVisitor *visitor = new ManDocVisitor(t,*this,ctx?ctx->getDefFileExtension():QCString(""));
  n->accept(visitor);
  delete visitor; 
  firstCol=FALSE;
  paragraph = FALSE;
}

void ManGenerator::writeEndAnnoItem ( const char *  )

inlinevirtual

Implements OutputGenerator.

Definition at line 154 of file mangen.h.

{ t << endl; firstCol=TRUE; }

void ManGenerator::writeFooter ( const char *  )

inlinevirtual

Implements OutputGenerator.

Definition at line 49 of file mangen.h.

{}

void ManGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable &  )

inlinevirtual

Implements OutputGenerator.

Definition at line 217 of file mangen.h.

{}

void ManGenerator::writeInheritedSectionTitle ( const char *  , const char *  , const char *  , const char *  , const char *  , const char *    )

inlinevirtual

Implements OutputGenerator.

Definition at line 167 of file mangen.h.

                                                              {}

void ManGenerator::writeLabel ( const char *  l, bool  isLast  )

virtual

Implements OutputGenerator.

Definition at line 820 of file mangen.cpp.

{
  t << "\\fC [" << l << "]\\fP";
  if (!isLast) t << ", ";
}

void ManGenerator::writeLatexSpacing ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 151 of file mangen.h.

{}

void ManGenerator::writeLineNumber ( const char *  ref, const char *  file, const char *  anchor, int  lineNumber  )

inlinevirtual

Writes the line number of a source listing

Parameters

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

Implements CodeOutputInterface.

Definition at line 134 of file mangen.h.

{ t << l << " "; }

void ManGenerator::writeLogo ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 192 of file mangen.h.

{}

void ManGenerator::writeNavigationPath ( const char *  )

inlinevirtual

Implements OutputGenerator.

Definition at line 191 of file mangen.h.

{}

void ManGenerator::writeNonBreakableSpace ( int  n )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 197 of file mangen.h.

{ int i; for (i=0;i<n;i++) t << " "; }

void ManGenerator::writeObjectLink ( const char *  ref, const char *  file, const char *  anchor, const char *  name  )

virtual

Writes a link to an object in the documentation.

Parameters

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.

Implements BaseOutputDocInterface.

Definition at line 244 of file mangen.cpp.

{
  startBold(); docify(name); endBold();
}

void ManGenerator::writePageLink ( const char *  , bool    )

inlinevirtual

Implements OutputGenerator.

Definition at line 55 of file mangen.h.

{}

void ManGenerator::writeQuickLinks ( bool  , HighlightedItem  , const char *    )

inlinevirtual

Implements OutputGenerator.

Definition at line 193 of file mangen.h.

{}

void ManGenerator::writeRuler ( )

inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 130 of file mangen.h.

{}

void ManGenerator::writeSearchInfo ( )

inlinevirtual

Implements OutputGenerator.

Definition at line 48 of file mangen.h.

{}

void ManGenerator::writeSplitBar ( const char *  )

inlinevirtual

Implements OutputGenerator.

Definition at line 190 of file mangen.h.

{}

void ManGenerator::writeStartAnnoItem ( const char *  type, const char *  file, const char *  path, const char *  name  )

virtual

Implements OutputGenerator.

Definition at line 239 of file mangen.cpp.

{
}

void ManGenerator::writeString ( const char *  text )

virtual

Writes an ASCII string to the output, without converting special characters.

Implements BaseOutputDocInterface.

Definition at line 226 of file mangen.cpp.

{
  docify(text);
}

void ManGenerator::writeStyleInfo ( int  )

inlinevirtual

Implements OutputGenerator.

Definition at line 58 of file mangen.h.

{}

void ManGenerator::writeSummaryLink ( const char *  , const char *  , const char *  , bool    )

inlinevirtual

Implements OutputGenerator.

Definition at line 194 of file mangen.h.

{}

void ManGenerator::writeSynopsis ( )

virtual

Implements OutputGenerator.

Definition at line 497 of file mangen.cpp.

{ 
  if (!firstCol) t << endl;
  t << ".SH SYNOPSIS\n.br\n.PP\n"; 
  firstCol=TRUE;
  paragraph=FALSE;
}

void ManGenerator::writeTooltip ( const char *  id, const DocLinkInfo &  docInfo, const char *  decl, const char *  desc, const SourceLinkInfo &  defInfo, const SourceLinkInfo &  declInfo  )

inlinevirtual

Writes a tool tip definition

Parameters

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

Implements CodeOutputInterface.

Definition at line 87 of file mangen.h.

                       {}

Member Data Documentation

int ManGenerator::col

private

Definition at line 267 of file mangen.h.

bool ManGenerator::firstCol

private

Definition at line 265 of file mangen.h.

bool ManGenerator::inHeader

private

Definition at line 270 of file mangen.h.

bool ManGenerator::insideTabbing

private

Definition at line 269 of file mangen.h.

bool ManGenerator::paragraph

private

Definition at line 266 of file mangen.h.

bool ManGenerator::upperCase

private

Definition at line 268 of file mangen.h.

---

The documentation for this class was generated from the following files:

• doxygen-1.8.11/src/mangen.h
• doxygen-1.8.11/src/mangen.cpp