DocSets Class Reference

#include <docsets.h>

Inheritance diagram for DocSets:

List of all members.


Public Member Functions
	DocSets ()
	~DocSets ()
void	initialize ()
void	finalize ()
void	incContentsDepth ()
void	decContentsDepth ()
void	addContentsItem (bool isDir, const char name, const char ref=0, const char file=0, const char anchor=0)
void	addIndexItem (const char level1, const char level2, const char contRef, const char memRef, const char anchor, const MemberDef md)
void	addIndexFile (const char *name)
Classes
struct	NodeDef

Detailed Description

A class that generates docset files. These files can be used to create context help for use within Apple's Xcode 3.0 development environment

Definition at line 33 of file docsets.h.

Constructor & Destructor Documentation

DocSets::DocSets ( )

Definition at line 23 of file docsets.cpp.

DocSets::~DocSets ( )

Definition at line 32 of file docsets.cpp.

Member Function Documentation

void DocSets::initialize ( ) [virtual]

Implements IndexIntf.

Definition at line 38 of file docsets.cpp.

References Config_getBool, Config_getString, err(), Doxygen::htmlFileExtension, and QCString.

void DocSets::finalize ( ) [virtual]

Implements IndexIntf.

Definition at line 160 of file docsets.cpp.

void DocSets::incContentsDepth ( ) [virtual]

Implements IndexIntf.

Definition at line 185 of file docsets.cpp.

void DocSets::decContentsDepth ( ) [virtual]

Implements IndexIntf.

Definition at line 196 of file docsets.cpp.

void DocSets::addContentsItem	(	bool	isDir,
		const char *	name,
		const char *	ref = `0`,
		const char *	file = `0`,
		const char *	anchor = `0`
	)			`[virtual]`

Implements IndexIntf.

Definition at line 206 of file docsets.cpp.

References convertToXML(), and Doxygen::htmlFileExtension.

void DocSets::addIndexItem	(	const char *	level1,
		const char *	level2,
		const char *	contRef,
		const char *	memRef,
		const char *	anchor,
		const MemberDef *	md
	)			`[virtual]`

Implements IndexIntf.

Definition at line 231 of file docsets.cpp.

References MemberDef::anchor, SDict< T >::append(), ClassDef::Category, ClassDef::Class, ClassDef::compoundType(), MemberDef::DCOP, MemberDef::Define, MemberDef::Enumeration, MemberDef::EnumValue, MemberDef::Event, SDict< T >::find(), MemberDef::Friend, MemberDef::Function, MemberDef::getClassDef(), MemberDef::getFileDef(), getLanguageFromFileName(), MemberDef::getNamespaceDef(), Definition::getOutputFileBase(), FileDef::getOutputFileBase(), ClassDef::includeInfo(), IncludeInfo::includeName, ClassDef::Interface, Definition::isLinkable(), FileDef::isLinkable(), MemberDef::isLinkable(), MemberDef::isObjCMethod(), ClassDef::isTemplate(), IncludeInfo::local, MemberDef::memberType(), Definition::name(), FileDef::name(), MemberDef::Property, MemberDef::Prototype, QCString, Definition::qualifiedName(), MemberDef::Signal, MemberDef::Slot, SrcLangExt_Cpp, SrcLangExt_CSharp, SrcLangExt_D, SrcLangExt_F90, SrcLangExt_IDL, SrcLangExt_Java, SrcLangExt_JS, SrcLangExt_ObjC, SrcLangExt_PHP, SrcLangExt_Python, SrcLangExt_VHDL, MemberDef::Typedef, and MemberDef::Variable.

void DocSets::addIndexFile ( const char * name ) [virtual]

Implements IndexIntf.

Definition at line 384 of file docsets.cpp.

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

Generated on Mon Mar 31 10:58:58 2008 by

doxygen

1.5.1