XRefDummyCodeGenerator Class Reference

Inheritance diagram for XRefDummyCodeGenerator:

Public Member Functions
	XRefDummyCodeGenerator (FileDef *fd)
	~XRefDummyCodeGenerator ()
void	codify (const char *)
void	writeCodeLink (const char *, const char *, const char *, const char *, const char *)
void	writeLineNumber (const char *, const char *, const char *, int)
virtual void	writeTooltip (const char *, const DocLinkInfo &, const char *, const char *, const SourceLinkInfo &, const SourceLinkInfo &)
void	startCodeLine (bool)
void	endCodeLine ()
void	startCodeAnchor (const char *)
void	endCodeAnchor ()
void	startFontClass (const char *)
void	endFontClass ()
void	writeCodeAnchor (const char *)
void	setCurrentDoc (Definition *, const char *, bool)
void	addWord (const char *, bool)
void	linkableSymbol (int l, const char *sym, Definition *symDef, Definition *context)
Public Member Functions inherited from CodeOutputInterface
virtual	~CodeOutputInterface ()

Private Attributes
FileDef *	m_fd

Detailed Description

Definition at line 42 of file doxyapp.cpp.

Constructor & Destructor Documentation

XRefDummyCodeGenerator::XRefDummyCodeGenerator ( FileDef *  fd )

inline

Definition at line 45 of file doxyapp.cpp.

: m_fd(fd) {}

XRefDummyCodeGenerator::~XRefDummyCodeGenerator ( )

inline

Definition at line 46 of file doxyapp.cpp.

{}

Member Function Documentation

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

inlinevirtual

Implements CodeOutputInterface.

Definition at line 64 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::codify ( const char *  s )

inlinevirtual

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 50 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::endCodeAnchor ( )

inline

Definition at line 59 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::endCodeLine ( )

inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 57 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::endFontClass ( )

inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 61 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::linkableSymbol ( int  l, const char *  sym, Definition *  symDef, Definition *  context  )

inline

Definition at line 67 of file doxyapp.cpp.

    {
      QCString ctx;
      if (context) // the context of the symbol is known
      {
        if (context->definitionType()==Definition::TypeMember) // it is inside a member
        {
          Definition *parentContext = context->getOuterScope();
          if (parentContext && parentContext->definitionType()==Definition::TypeClass)
             // it is inside a member of a class
          {
            ctx.sprintf("inside %s %s of %s %s",
              ((MemberDef *)context)->memberTypeName().data(),
              context->name().data(),
              ((ClassDef*)parentContext)->compoundTypeString().data(),
              parentContext->name().data());
          }
          else if (parentContext==Doxygen::globalScope) // it is inside a global member
          {
            ctx.sprintf("inside %s %s",
              ((MemberDef *)context)->memberTypeName().data(),
              context->name().data());
          }
        }
        if (ctx.isEmpty()) // it is something else (class, or namespace member, ...)
        {
          ctx.sprintf("in %s",context->name().data());
        }
      }
      printf("Found symbol %s at line %d of %s %s\n",
          sym,l,m_fd->getDefFileName().data(),ctx.data());
      if (symDef && context) // in this case the definition of the symbol is
        // known to doxygen.
      {
        printf("-> defined at line %d of %s\n",
            symDef->getDefLine(),symDef->getDefFileName().data());
      }
    }

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

inlinevirtual

Implements CodeOutputInterface.

Definition at line 63 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::startCodeAnchor ( const char *  )

inline

Definition at line 58 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::startCodeLine ( bool  )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 56 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::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 60 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::writeCodeAnchor ( const char *  name )

inlinevirtual

Write an anchor to a source listing.

Parameters

name	The name of the anchor.

Implements CodeOutputInterface.

Definition at line 62 of file doxyapp.cpp.

{}

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

inlinevirtual

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 51 of file doxyapp.cpp.

{}

void XRefDummyCodeGenerator::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 52 of file doxyapp.cpp.

{}

virtual void XRefDummyCodeGenerator::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 53 of file doxyapp.cpp.

                                                      {}

Member Data Documentation

FileDef* XRefDummyCodeGenerator::m_fd

private

Definition at line 106 of file doxyapp.cpp.

---

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

• doxygen-1.8.11/addon/doxyapp/doxyapp.cpp