DelphiCodeToDoc - Free documentation tool for Delphi with JavaDoc support

DelphiCodeToDoc

Name

uOptions

Parent

Description

Module that centralize all Options.
This module contains the TDOCOptions, and all informations for each option :
Name, Description, Values, translations, etc ...
http://dephicodetodoc.sourceforge.net/
Copyright TridenT 2003 - Under GNU GPL licence

Author

TridenT

Version

2003/12/01 TridenT Initial revision
2004/08/06 TridenT Added 'CommentDecoratorChar' option
2004/09/04 TridenT Added 'HideEmptyOutputBlock' option
2005/09/05 TridenT Added 'AllowHtmlInDescription' option
2007/04/01 TridenT Added ocRecords in OutputFilteringCategory option
2007/04/17 TridenT Added 'MethodCommentFromAncestor' option

Types

Type	Description
TLanguage (+)	List of language supported by the application
TMemberVisibility (+)	List of keywords for Member visiblity
TOutputCategoryList (+)	List of member category
TOutputCategoryListSet (+)	Set of member category
TOutputFormat (+)	OutPut format Styles for the Generated Documentation
TRWOptionsError (+)	Return value for managing project's configuration file
TTagComment (+)	List of supported TAG recognition
TTagCommentSet (+)	Set of TAG recognition
TVisibilitySet (+)	Set of Member visibility

Constants

Constant	Description
ccApplicationOptions (+)	#No TAG found in source code#
ccCommentRules (+)	#No TAG found in source code#
ccFilesList (+)	#No TAG found in source code#
ccInputOptions (+)	#No TAG found in source code#
ccJavaDocPrefixOptions (+)	#No TAG found in source code#
ccJavaDocSupportOptions (+)	#No TAG found in source code#
ccOutputOptions (+)	#No TAG found in source code#
C_APPLICATION_PROPERTYS_DESCRIPTION (+)	List of Applications properties
C_COMMENT_RULES (+)	List of comment rules properties
C_FILES_LIST_PROPERTYS_DESCRIPTION (+)	List of file list properties
C_INPUT_PROPERTYS_DESCRIPTION (+)	list of Input properties
C_JAVADOC_PREFIX_PROPERTYS_DESCRIPTION (+)	List of javaDoc prefix properties
C_JAVADOC_SUPPORT_PROPERTYS_DESCRIPTION (+)	List of JavaDoc properties
C_OPTIONS_IDENTIFICATION_END (+)	ENDING ID in the project file
C_OPTIONS_IDENTIFICATION_START (+)	STARTING ID in the project file
C_OPTIONS_TECHNICAL_LEVEL (+)	Technical level of saved project's file is the compatibility level of fiels.
C_OUTPUT_PROPERTYS_DESCRIPTION (+)	List of Output properties
L_EnterProjectDescription (+)	#No TAG found in source code#
L_EnterProjectSummary (+)	#No TAG found in source code#
L_InsertAuthorName (+)	#No TAG found in source code#
L_InsertProjectTitle (+)	#No TAG found in source code#
L_Project1 (+)	#No TAG found in source code#
oeTextIDEndNOK (+)	#No TAG found in source code#
oeTextIDStartNOK (+)	#No TAG found in source code#
oeTextNoError (+)	#No TAG found in source code#
oeTextTechLevelNOK (+)	#No TAG found in source code#
oeTextUnknown (+)	#No TAG found in source code#
oeTextUpgraded (+)	#No TAG found in source code#
pdCaptionAllowHtmlInDescription (+)	#No TAG found in source code#
pdCaptionAuthor (+)	#No TAG found in source code#
pdCaptionBoolsAsChecks (+)	#No TAG found in source code#
pdCaptionBracketStarJavaDocCharPrefix (+)	#No TAG found in source code#
pdCaptionConditionalDefines (+)	#No TAG found in source code#
pdCaptionCopyright (+)	#No TAG found in source code#
pdCaptionCurlyJavaDocCharPrefix (+)	#No TAG found in source code#
pdCaptionCustomFooter (+)	#No TAG found in source code#
pdCaptionCustomHeader (+)	#No TAG found in source code#
pdCaptionDescription (+)	#No TAG found in source code#
pdCaptionDisplayHiddenItems (+)	#No TAG found in source code#
pdCaptionFilesExcludeList (+)	#No TAG found in source code#
pdCaptionFilesIncludeList (+)	#No TAG found in source code#
pdCaptionHideEmptyOutputBlock (+)	#No TAG found in source code#
pdCaptionHideEmptyTAGSection (+)	#No TAG found in source code#
pdCaptionHTMLLink (+)	#No TAG found in source code#
pdCaptionInLineJavaDocCharPrefix (+)	#No TAG found in source code#
pdCaptionLanguage (+)	#No TAG found in source code#
pdCaptionLaunchBrowser (+)	#No TAG found in source code#
pdCaptionMethodCommentFromAncestor (+)	#No TAG found in source code#
pdCaptionName (+)	#No TAG found in source code#
pdCaptionOutputFilteringCategory (+)	#No TAG found in source code#
pdCaptionOutputFolder (+)	#No TAG found in source code#
pdCaptionOutputFormat (+)	#No TAG found in source code#
pdCaptionParseImplementationSection (+)	#No TAG found in source code#
pdCaptionPropertyCommentFromAssessors (+)	#No TAG found in source code#
pdCaptionRecurseDirectory (+)	#No TAG found in source code#
pdCaptionSkipFirstTAGLine (+)	#No TAG found in source code#
pdCaptionSkipLastTAGLine (+)	#No TAG found in source code#
pdCaptionSummary (+)	#No TAG found in source code#
pdCaptionTagCommentSet (+)	#No TAG found in source code#
pdCaptionTitle (+)	#No TAG found in source code#
pdCaptionVisibilitySet (+)	#No TAG found in source code#
pdNameAllowHtmlInDescription (+)	#No TAG found in source code#
pdNameAuthor (+)	#No TAG found in source code#
pdNameBoolsAsChecks (+)	#No TAG found in source code#
pdNameBracketStarJavaDocCharPrefix (+)	#No TAG found in source code#
pdNameConditionalDefines (+)	#No TAG found in source code#
pdNameCopyright (+)	#No TAG found in source code#
pdNameCurlyJavaDocCharPrefix (+)	#No TAG found in source code#
pdNameCustomFooter (+)	#No TAG found in source code#
pdNameCustomHeader (+)	#No TAG found in source code#
pdNameDescription (+)	#No TAG found in source code#
pdNameDisplayHiddenItems (+)	#No TAG found in source code#
pdNameFilesExcludeList (+)	#No TAG found in source code#
pdNameFilesIncludeList (+)	#No TAG found in source code#
pdNameHideEmptyOutputBlock (+)	#No TAG found in source code#
pdNameHideEmptyTAGSection (+)	#No TAG found in source code#
pdNameHTMLLink (+)	#No TAG found in source code#
pdNameInLineJavaDocCharPrefix (+)	#No TAG found in source code#
pdNameLanguage (+)	#No TAG found in source code#
pdNameLaunchBrowser (+)	#No TAG found in source code#
pdNameMethodCommentFromAncestor (+)	#No TAG found in source code#
pdNameName (+)	#No TAG found in source code#
pdNameOutputFilteringCategory (+)	#No TAG found in source code#
pdNameOutputFolder (+)	#No TAG found in source code#
pdNameOutputFormat (+)	#No TAG found in source code#
pdNameParseImplementationSection (+)	#No TAG found in source code#
pdNamePropertyCommentFromAssessors (+)	#No TAG found in source code#
pdNameRecurseDirectory (+)	#No TAG found in source code#
pdNameSkipFirstTAGLine (+)	#No TAG found in source code#
pdNameSkipLastTAGLine (+)	#No TAG found in source code#
pdNameSortAlpha (+)	#No TAG found in source code#
pdNameSummary (+)	#No TAG found in source code#
pdNameTagCommentSet (+)	#No TAG found in source code#
pdNameTitle (+)	#No TAG found in source code#
pdNameVisibilitySet (+)	#No TAG found in source code#
pdNameWarnEmptyTAG (+)	#No TAG found in source code#
psCaptionSortAlpha (+)	#No TAG found in source code#
psCaptionWarnEmptyTAG (+)	#No TAG found in source code#
RWOptionsErrorStrings (+)	Error code return by some functions

Methods

Method	Description
CreateApplicationStorage (+)	Create application storage and setup (FACTORY)

Classes

Class	Description
TDOCOptions (+)	Holder for all Options module
TPropertyDescription (+)	Description of options by short name and name

Legend

Symbol	Visibility
-	Private
#	Protected
+	Public
*	Published
A	Automated
S	Strict

DelphiCodeToDoc

Class Tree

Index

Previous (uOldOptions)

Next (VisitComment)