CL_CLASS_DOCU_GENERATOR - Documentation Generator

SUBST_MERGE_LIST - merge external lists to one complete list with #if... logic for R3up   General Material Data  
This documentation is copyright by SAP AG.

>>> Development Documentation generated by DocuGenerator v2.0 (only available in English => NO TRANSLATION!!!) <<<

General Class Description

This class reads all relevant class informations and generates a SAPScript class documentation

__________________________________________________________

Class Info

Name:	CL_CLASS_DOCU_GENERATOR
Instantiation:	Public

Superclass

None

Implemented Interfaces

None

Friend Classes

None

Subclasses

None

__________________________________________________________

Methods

ADD_MESSAGE_SYMSG

Private ADD_MESSAGE_SYMSG( )

This method adds the message information from the systems variables to the message log
The message needs to be raised by the MESSAGE statement right before (keep where-used-list)

________________________________________________________________________

APPEND_OUTPUT

Private APPEND_OUTPUT(

IMPORTING	STRING	IV_OUTPUT
ABAP_BOOL	IV_CREATE_DOCU_LINK
ABAP_BOOL	IV_CREATE_ALL

)

This method appends the output sting to the output table considering SAPScript restrictions

-	IV_CREATE_DOCU_LINK	Indicates that the class/interface names should be replaced by class/interface documenation links
-	IV_CREATE_ALL	Indicates that only the first class/interface names should be replaced

________________________________________________________________________

BUILD_CLASS_DOCU_STRUCTURE

Private BUILD_CLASS_DOCU_STRUCTURE( )

This method builds the whole class documentation structure

________________________________________________________________________

BUILD_CLASS_INFO

Private BUILD_CLASS_INFO( )

This method builds the class header info

________________________________________________________________________

BUILD_METHOD_INFO

Private BUILD_METHOD_INFO( )

This method builds the method infos

________________________________________________________________________

CONSTRUCTOR

Public CONSTRUCTOR(

IMPORTING

SEOCLSNAME

IV_CLASS_NAME

)

Class Documentation Generator Constructor
- reads the class info
- builds the class docu structure

Parameters

-

IV_CLASS_NAME

Name of the class the documentation is to be generated

Exceptions

-

CX_CLASS_DOCU_GENERATOR

Class documentation exception (e.g. class does not exist)

________________________________________________________________________

CREATE_DOCU_CLASS_HEADER

Private CREATE_DOCU_CLASS_HEADER( )

This method creates the class header for the class documentation

________________________________________________________________________

CREATE_DOCU_LINK

Private CREATE_DOCU_LINK(

IMPORTING	ABAP_BOOL	IV_CREATE_ALL
CHANGING	STRING	CV_STRING

)

This method replaces class/interface names with documentation links

Parameters

-	IV_CREATE_ALL	Indicator
	- true: replace all class/interface name occurrences
	- false: replace only first class/interface name occurrence
-	CV_STRING	String where the class/interface names should be replaced

________________________________________________________________________

CREATE_DOCU_METHOD_DETAILS

Private CREATE_DOCU_METHOD_DETAILS(

IMPORTING

CRMS_METHOD_INFO

IS_METHOD_INFO

)

This method creates the method details for the class documentation

Parameters

-

IS_METHOD_INFO

Method info structure

________________________________________________________________________

CREATE_DOCU_METHOD_HEADER

Private CREATE_DOCU_METHOD_HEADER(

IMPORTING

CRMS_METHOD_INFO

IS_METHOD_INFO

)

This method creates the method header for the class documentation

Parameters

-

IS_METHOD_INFO

Method info structure

________________________________________________________________________

FIND_NEXT_JD_TAG

Private FIND_NEXT_JD_TAG(

EXPORTING	NAME_KOMP	EV_TAG_VALUE
CHAR20	EV_NEXT_TAG
RSWSOURCET	ET_DESCRIPTION
CHANGING	RSWSOURCET	CT_SOURCE
I	CV_NEXT_INDENT

)

This method collects the description until the next JavaDoc-like tag
Known tag values:
- Method docu starts:CL_CLASS_DOCU_GENERATOR=>CO_JD_DOCU_START
- Method docu end: CL_CLASS_DOCU_GENERATOR=>CO_JD_DOCU_END
- Parameter: CL_CLASS_DOCU_GENERATOR=>CO_JD_PARAM
- Return: CL_CLASS_DOCU_GENERATOR=>CO_JD_RETURN
- Exception: CL_CLASS_DOCU_GENERATOR=>CO_JD_THROWS

Parameters

-	EV_TAG_VALUE	Tag value
-	EV_NEXT_TAG	Next/Last found tag
-	ET_DESCRIPTION	Description found until foundtag
-	CT_SOURCE	Source description
-	CV_NEXT_INDENT	Next indent to be used

________________________________________________________________________

FIND_NEXT_XML_TAG

Private FIND_NEXT_XML_TAG(

EXPORTING	NAME_KOMP	EV_TAG_VALUE
CHAR20	EV_NEXT_TAG
ABAP_BOOL	EV_END_TAG
RSWSOURCET	ET_DESCRIPTION
CHANGING	RSWSOURCET	CT_SOURCE

)

This method collects the description until the next JavaDoc-like tag
Known tag values:
- Class docu:CL_CLASS_DOCU_GENERATOR=>CO_XML_CLASS_DOCU
- Method docu: CL_CLASS_DOCU_GENERATOR=>CO_XML_METHOD_DOCU
- Parameter: CL_CLASS_DOCU_GENERATOR=>CO_XML_PARAM
- Return: CL_CLASS_DOCU_GENERATOR=>CO_XML_RETURNS
- Exception: CL_CLASS_DOCU_GENERATOR=>CO_XML_EXCEPTION

Parameters

-	EV_TAG_VALUE	Tag value
-	EV_NEXT_TAG	Next/Last found tag
-	EV_END_TAG	Indicates that an end tag has been found
-	ET_DESCRIPTION	Description found until foundtag
-	CT_SOURCE	Source description

________________________________________________________________________

GET_CLASS_DOCU

Public GET_CLASS_DOCU(

IMPORTING	ABAP_BOOL	IV_ADD_DOCU_HEADER
EXPORTING	CRMT_MKTGS_DOCGEN_OUTPUT	ET_CLASS_DOCU

)

This method generates the class documentation out of the class information

Parameters

-	IV_ADD_DOCU_HEADER	Indicates that the documentation header should be added
-	ET_CLASS_DOCU	Table with class documentation

________________________________________________________________________

GET_DDIC_VALUE

Private STRING GET_DDIC_VALUE(

IMPORTING	FIELDNAME	IV_FIELDNAME
STRUKNAME	IV_STRUCTURE
ANY	IV_VALUE

)

This method determines the external DDIC value from the internal DDICkey (e.g. domain value)

Returns

External DDIC value

Parameters

-	IV_FIELDNAME	Field name
-	IV_STRUCTURE	Structure name where the field is included
	Internal DDIC key

________________________________________________________________________

GET_GENERATION_INFO

Private STRING GET_GENERATION_INFO( )

This method returns the class documentation generation info line

________________________________________________________________________

GET_MESSAGE_LOG

Public GET_MESSAGE_LOG(

EXPORTING

BAPIRETTAB

ET_MESSAGE_LOG

)

This method returns the generation log

Parameters

-

ET_MESSAGE_LOG

Returning message log

________________________________________________________________________

PARSE_DOCU_JD

Private PARSE_DOCU_JD(

CHANGING

CRMS_METHOD_INFO

CS_METHOD_INFO

)

This method parses the comments using JavaDoc-like tags

Parameters

-

CS_METHOD_INFO

Method info structure

________________________________________________________________________

PARSE_DOCU_XML

Private PARSE_DOCU_XML(

CHANGING

CRMS_METHOD_INFO

CS_METHOD_INFO

)

This method parses the comments using XML-like tags

Parameters

-

CS_METHOD_INFO

Method info structure

________________________________________________________________________

READ_CLASS_INFO

Private READ_CLASS_INFO(

IMPORTING

SEOCLSNAME

IV_CLASS_NAME

)

This method reads the class information

Parameters

-

IV_CLASS_NAME

Class name the info should be read for

Exceptions

-

CX_CLASS_DOCU_GENERATOR

Class documentation exception (e.g. class does not exist)

CPI1466 during Backup   SUBST_MERGE_LIST - merge external lists to one complete list with #if... logic for R3up  
This documentation is copyright by SAP AG.


Length: 20304 Date: 20120526 Time: 101837     triton ( 185 ms )