SAP ABAP Class CL_UML_CLASS_DECOR_ABAPDOC (UML Plug-In: Generate AbapDoc HTML)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ S_ABAP_TOOLS_DOC (Package) AbapDoc Plug-In for UML-tool
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_UML_CLASS_DECORATOR Decorator for UML Class Diagrams 20090403
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_UML_TOOL_PLUGIN Plug-In for UML Tool 20090403
Properties
Class CL_UML_CLASS_DECOR_ABAPDOC  
Short Description UML Plug-In: Generate AbapDoc HTML    
Super Class CL_UML_CLASS_DECORATOR Decorator for UML Class Diagrams 
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status P  SAP Standard Production Program 
Category 0   
Package S_ABAP_TOOLS_DOC   AbapDoc Plug-In for UML-tool 
Created 20090403   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_UML_TOOL_PLUGIN Plug-In for UML Tool 20090403
Friends
Class CL_UML_CLASS_DECOR_ABAPDOC has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 O_ABAPDOC Instance attribute Protected Object reference (TYPE REF TO) IF_ADOC_SCANNER AbapDoc Scanner 20090408
2 PRJ_CONFIG Instance attribute Protected Type reference (TYPE) LTY_PRJ_CONFIG Configuration Data 20090403
3 T_ABAPDOC Instance attribute Protected Type reference (TYPE) LTY_ABAPDOCS Array for AbapDoc Cache 20090408
Methods
# Method Level Visibility Method type Description Created on
1 ASSIGN_ATTR_DOCU_SECTION Instance method Private Method Assign Section for Documentation 20130426
2 ASSIGN_CLASS_DOCU_SECTION Instance method Private Method Assign Section for Documentation 20130426
3 ASSIGN_EVENT_DOCU_SECTION Instance method Private Method Assign Section for Documentation 20130426
4 ASSIGN_METHOD_DOCU_SECTION Instance method Private Method Assign Section for Documentation 20130426
5 CONSTRUCTOR Instance method Public Constructor Constructor 20090403
6 CREATE_CLASS_HTML Instance method Private Method Create a page for each class in HTML 20090403
7 CREATE_CSS Instance method Private Method Create CSS File 20090619
8 CREATE_FUNCTION_HTML Instance method Private Method Create a page for each function group in HTML 20090403
9 CREATE_INDEX_HTML Instance method Private Method Create an index page in HTML 20090403
10 CREATE_INTERFACE_HTML Instance method Private Method Create a page for each interface in HTML 20090403
11 CREATE_JNET_DIAGRAM Instance method Private Method Create UML Diagram Using JNet 20090403
12 CREATE_PACKAGE_HTML Instance method Private Method Create index page in HTML for each package 20090403
13 CREATE_PROGRAM_HTML Instance method Private Method Create page in HTML for each program 20090403
14 CREATE_STRUCTURE_HTML Instance method Private Method Create page in HTML for each structure 20090403
15 DOCU_GET Static method Private Method Get Workbench Documentation 20130806
16 FILL_CLASS_DOC Instance method Private Method Use AbapDoc Comments 20090603
17 GENERATE_FILE_NAME Static method Private Method Generate File Names 20090610
18 GET_CLASS_ABAPDOC Instance method Private Method Get Local Class Documentation 20090408
19 GET_CLASS_DOCUMENTATION Instance method Private Method Get Class Documentation 20090403
20 GET_FUNCTION_DOCUMENTATION Instance method Private Method Get Function Group Documentation 20090403
21 GET_INTERFACE_DOCUMENTATION Instance method Private Method Get Interface Documentation 20090403
22 GET_PROGRAM_DOCUMENTATION Instance method Private Method Get Program Documentation 20090403
23 GET_STRUCTURE_DOCUMENTATION Instance method Private Method Get Class Documentation 20090720
24 SET_CONFIGURATION Instance method Public Method Set Parameters for HTML Generation 20090403
Events
Class CL_UML_CLASS_DECOR_ABAPDOC has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 LTY_ABAPDOC Protected See coding Row for AbapDoc Cache 20090408 BEGIN OF lty_abapdoc, name TYPE string, class TYPE REF TO if_adoc_class, END OF lty_abapdoc
2 LTY_ABAPDOCS Protected See coding Array for AbapDoc Cache 20090408 lty_abapdocs TYPE STANDARD TABLE OF lty_abapdoc WITH KEY name
3 LTY_DOCU Private See coding 20130806 LTY_DOCU type STANDARD TABLE OF tline
4 LTY_INDEX Private See coding Index for File Name 20090403 BEGIN OF lty_index, packages TYPE lty_indx_names, * classes TYPE lty_indx_names, * interfaces TYPE lty_indx_names, * programs TYPE lty_indx_names, * functions TYPE lty_indx_names, * structures TYPE lty_indx_names, * primitives TYPE lty_indx_names, END OF lty_index
5 LTY_INDX_NAME Private See coding Index for File Name 20090403 BEGIN OF lty_indx_name, name TYPE string, file TYPE string, text TYPE string, END OF lty_indx_name
6 LTY_INDX_NAMES Private See coding Index for File Name 20090403 lty_indx_names TYPE STANDARD TABLE OF lty_indx_name WITH KEY name
7 LTY_PACKAGE Private See coding Package 20090403 BEGIN OF lty_package, package TYPE string, classes TYPE lty_prj_classes, interfaces TYPE lty_prj_classes, programs TYPE lty_prj_classes, functions TYPE lty_prj_classes, primitives TYPE lty_primitive_tab, structures TYPE lty_prj_classes, * associations TYPE lty_associations, * usage TYPE lty_usages, * friends TYPE lty_friends, END OF lty_package
8 LTY_PACKAGES Private See coding Packages 20090403 lty_packages TYPE STANDARD TABLE OF lty_package WITH KEY package
9 LTY_PACK_INDEX Private See coding Index for File Name 20090403 BEGIN OF lty_pack_index, name TYPE string, classes TYPE lty_indx_names, interfaces TYPE lty_indx_names, programs TYPE lty_indx_names, functions TYPE lty_indx_names, structures TYPE lty_indx_names, * primitives TYPE lty_indx_names, END OF lty_pack_index
10 LTY_PRIMITIVE_TAB Private See coding Primitive Type 20090403 lty_primitive_tab TYPE STANDARD TABLE OF lty_primitive_type WITH KEY name
11 LTY_PRIMITIVE_TYPE Private See coding Primitive Type 20090403 BEGIN OF lty_primitive_type, name TYPE string, container TYPE string, kind(1) TYPE c, visibility(1) TYPE c, END OF lty_primitive_type
12 LTY_PRJ_ADOCU Private See coding Attribute Documentation 20090403 BEGIN OF lty_prj_adocu, name TYPE string, abapdoc TYPE STANDARD TABLE OF string WITH KEY table_line, meaning TYPE STANDARD TABLE OF string WITH KEY table_line, hints TYPE STANDARD TABLE OF string WITH KEY table_line, END OF lty_prj_adocu
13 LTY_PRJ_ADOCU_TAB Private See coding Attribute Documentation 20090403 lty_prj_adocu_tab TYPE STANDARD TABLE OF lty_prj_adocu WITH KEY name
14 LTY_PRJ_CDOCU Private See coding Class Documentation 20090403 BEGIN OF lty_prj_cdocu, abapdoc TYPE STANDARD TABLE OF string WITH KEY table_line, functionality TYPE STANDARD TABLE OF string WITH KEY table_line, relations TYPE STANDARD TABLE OF string WITH KEY table_line, meaning TYPE STANDARD TABLE OF string WITH KEY table_line, use TYPE STANDARD TABLE OF string WITH KEY table_line, recommendation TYPE STANDARD TABLE OF string WITH KEY table_line, example TYPE STANDARD TABLE OF string WITH KEY table_line, hints TYPE STANDARD TABLE OF string WITH KEY table_line, further TYPE STANDARD TABLE OF string WITH KEY table_line, purpose TYPE STANDARD TABLE OF string WITH KEY table_line, integration TYPE STANDARD TABLE OF string WITH KEY table_line, prerequisites TYPE STANDARD TABLE OF string WITH KEY table_line, dependencies TYPE STANDARD TABLE OF string WITH KEY table_line, features TYPE STANDARD TABLE OF string WITH KEY table_line, selection TYPE STANDARD TABLE OF string WITH KEY table_line, standard_variants TYPE STANDARD TABLE OF string WITH KEY table_line, output TYPE STANDARD TABLE OF string WITH KEY table_line, activities TYPE STANDARD TABLE OF string WITH KEY table_line, t_methods TYPE lty_prj_mdocu_tab, t_properties TYPE lty_prj_adocu_tab, t_events TYPE lty_prj_edocu_tab, END OF lty_prj_cdocu
15 LTY_PRJ_CLASS Private See coding Class 20090403 BEGIN OF lty_prj_class, name TYPE string, absname TYPE string, file TYPE string, docu TYPE lty_prj_cdocu, package TYPE string, description TYPE vseoclass-descript, container TYPE string, has_diagram(1) TYPE c, visibility(1) TYPE c, kind(1) TYPE c, is_final(1) TYPE c, is_abstract(1) TYPE c, is_local(1) TYPE c, is_exception(1) TYPE c, is_persistent(1) TYPE c, is_agent(1) TYPE c, supertype TYPE string, superfile TYPE string, t_properties TYPE uml_type_attributes_tab, t_implementations TYPE lty_prj_impls, t_dependencies TYPE lty_prj_impls, t_lcl_classes TYPE lty_prj_impls, t_lcl_interfaces TYPE lty_prj_impls, t_lcl_types TYPE lty_prj_impls, t_users TYPE lty_prj_impls, t_childs TYPE lty_prj_impls, t_method TYPE uml_type_methods_tab, t_locals TYPE lty_prj_locals_tab, t_events TYPE uml_type_events_tab, END OF lty_prj_class
16 LTY_PRJ_CLASSES Private See coding Table with Classes 20090403 lty_prj_classes TYPE STANDARD TABLE OF lty_prj_class WITH KEY name
17 LTY_PRJ_CONFIG Protected See coding Configuration Data 20090403 BEGIN OF lty_prj_config, filename TYPE string, path TYPE string, jnet TYPE REF TO cl_gui_jnet, xml TYPE xstring, END OF lty_prj_config
18 LTY_PRJ_EDOCU Private See coding Event Documentation 20090403 BEGIN OF lty_prj_edocu, name TYPE string, abapdoc TYPE STANDARD TABLE OF string WITH KEY table_line, meaning TYPE STANDARD TABLE OF string WITH KEY table_line, parameters TYPE STANDARD TABLE OF string WITH KEY table_line, hints TYPE STANDARD TABLE OF string WITH KEY table_line, END OF lty_prj_edocu
19 LTY_PRJ_EDOCU_TAB Private See coding Event Documentation 20090403 lty_prj_edocu_tab TYPE STANDARD TABLE OF lty_prj_edocu WITH KEY name
20 LTY_PRJ_IMPL Private See coding Implementations 20090403 BEGIN OF lty_prj_impl, name TYPE string, absname TYPE string, file TYPE string, END OF lty_prj_impl
21 LTY_PRJ_IMPLS Private See coding Implementations 20090403 lty_prj_impls TYPE STANDARD TABLE OF lty_prj_impl WITH KEY name
22 LTY_PRJ_LOCALS Private See coding Local Types 20090403 BEGIN OF lty_prj_locals, name TYPE string, type TYPE string, kind(1) TYPE c, visibility TYPE abap_visibility, END OF lty_prj_locals
23 LTY_PRJ_LOCALS_TAB Private See coding Local Types 20090403 lty_prj_locals_tab TYPE STANDARD TABLE OF lty_prj_locals WITH KEY name
24 LTY_PRJ_MDOCU Private See coding Method Documentation 20090403 BEGIN OF lty_prj_mdocu, name TYPE string, abapdoc TYPE STANDARD TABLE OF string WITH KEY table_line, functionality TYPE STANDARD TABLE OF string WITH KEY table_line, precondition TYPE STANDARD TABLE OF string WITH KEY table_line, result TYPE STANDARD TABLE OF string WITH KEY table_line, parameters TYPE STANDARD TABLE OF string WITH KEY table_line, exceptions TYPE STANDARD TABLE OF string WITH KEY table_line, hints TYPE STANDARD TABLE OF string WITH KEY table_line, examples TYPE STANDARD TABLE OF string WITH KEY table_line, further TYPE STANDARD TABLE OF string WITH KEY table_line, END OF lty_prj_mdocu
25 LTY_PRJ_MDOCU_TAB Private See coding Method Documentation 20090403 lty_prj_mdocu_tab TYPE STANDARD TABLE OF lty_prj_mdocu WITH KEY name
Method Signatures

Method ASSIGN_ATTR_DOCU_SECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing ATTRIBUTE Call by reference Type reference (TYPE) LTY_PRJ_ADOCU Attribute 20130426
2 Changing TABLE Value transfer Object reference (TYPE REF TO) DATA Table 20130426
3 Importing TDLINE Call by reference Type reference (TYPE) TDLINE Formatspalte 20130426

Method ASSIGN_ATTR_DOCU_SECTION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method ASSIGN_CLASS_DOCU_SECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CLASS Call by reference Type reference (TYPE) LTY_PRJ_CLASS Klasse 20130426
2 Changing TABLE Value transfer Object reference (TYPE REF TO) DATA 20130426
3 Importing TDLINE Call by reference Type reference (TYPE) TDLINE Formatspalte 20130426

Method ASSIGN_CLASS_DOCU_SECTION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method ASSIGN_EVENT_DOCU_SECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing EVENT Call by reference Type reference (TYPE) LTY_PRJ_EDOCU Event 20130426
2 Changing TABLE Value transfer Object reference (TYPE REF TO) DATA Table 20130426
3 Importing TDLINE Call by reference Type reference (TYPE) TDLINE Formatspalte 20130426

Method ASSIGN_EVENT_DOCU_SECTION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method ASSIGN_METHOD_DOCU_SECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing METHOD Call by reference Type reference (TYPE) LTY_PRJ_MDOCU Method 20130426
2 Changing TABLE Value transfer Object reference (TYPE REF TO) DATA Table 20130426
3 Importing TDLINE Call by reference Type reference (TYPE) TDLINE Formatspalte 20130426

Method ASSIGN_METHOD_DOCU_SECTION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DECORATOR Call by reference Object reference (TYPE REF TO) CL_UML_CLASS_SCANNER Dekorator für UML Klassendiagramme 20090403

Method CONSTRUCTOR on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CREATE_CLASS_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing I_TAB Call by reference Type reference (TYPE) LTY_PACKAGES Tabelle mit allen Daten. 20090403

Method CREATE_CLASS_HTML on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CREATE_CSS Signature

Method CREATE_CSS on class CL_UML_CLASS_DECOR_ABAPDOC has no parameter.
Method CREATE_CSS on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CREATE_FUNCTION_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing I_TAB Call by reference Type reference (TYPE) LTY_PACKAGES Tabelle mit allen Daten. 20090403

Method CREATE_FUNCTION_HTML on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CREATE_INDEX_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_TAB Call by reference Type reference (TYPE) LTY_PACKAGES Tabelle mit allen Daten. 20090403

Method CREATE_INDEX_HTML on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CREATE_INTERFACE_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing I_TAB Call by reference Type reference (TYPE) LTY_PACKAGES Tabelle mit allen Daten. 20090403

Method CREATE_INTERFACE_HTML on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CREATE_JNET_DIAGRAM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_PACKAGES Call by reference Type reference (TYPE) UML_RANGE_PACKAGES zentrales Paket 20090403
2 Importing I_TYPES Call by reference Type reference (TYPE) UML_RANGE_TYPES alle Typen 20090403
3 Importing TYPE Call by reference Type reference (TYPE) STRING zentraler Typ 20090403

Method CREATE_JNET_DIAGRAM on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CREATE_PACKAGE_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_TAB Call by reference Type reference (TYPE) LTY_PACKAGES Tabelle mit allen Daten. 20090403

Method CREATE_PACKAGE_HTML on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CREATE_PROGRAM_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing I_TAB Call by reference Type reference (TYPE) LTY_PACKAGES Tabelle mit allen Daten. 20090403

Method CREATE_PROGRAM_HTML on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method CREATE_STRUCTURE_HTML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing I_TAB Call by reference Type reference (TYPE) LTY_PACKAGES Tabelle mit allen Daten. 20090403

Method CREATE_STRUCTURE_HTML on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method DOCU_GET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_DOCU Call by reference Type reference (TYPE) LTY_DOCU 20130806
2 Importing I_ID Call by reference Type reference (TYPE) DOKHL-ID Dokumentenklasse 20130806
3 Importing I_OBJECT Call by reference Type reference (TYPE) DOKHL-OBJECT Dokumentations-Objekt 20130806
4 Importing I_TYP Call by reference Type reference (TYPE) DOKHL-TYP 'E' Dokumentationstyp 20130806

Method DOCU_GET on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method FILL_CLASS_DOC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ADOC_CLASS Call by reference Object reference (TYPE REF TO) IF_ADOC_CLASS Informationen über eine Klasse oder ein Interface 20090603
2 Changing CLASS Call by reference Type reference (TYPE) LTY_PRJ_CLASS Klasse 20090603

Method FILL_CLASS_DOC on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method GENERATE_FILE_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning FILENAME Value transfer Type reference (TYPE) STRING Dateiname 20090610
2 Importing SUFFIX Call by reference Type reference (TYPE) STRING `.html` Suffix 20090610
3 Importing TYPE Call by reference Type reference (TYPE) STRING Absoluter Name 20090610

Method GENERATE_FILE_NAME on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method GET_CLASS_ABAPDOC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CLASS Call by reference Type reference (TYPE) LTY_PRJ_CLASS Klasse 20090408

Method GET_CLASS_ABAPDOC on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method GET_CLASS_DOCUMENTATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CLASS Call by reference Type reference (TYPE) LTY_PRJ_CLASS Klasse 20090403

Method GET_CLASS_DOCUMENTATION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method GET_FUNCTION_DOCUMENTATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CLASS Call by reference Type reference (TYPE) LTY_PRJ_CLASS Klasse 20090403

Method GET_FUNCTION_DOCUMENTATION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method GET_INTERFACE_DOCUMENTATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CLASS Call by reference Type reference (TYPE) LTY_PRJ_CLASS Klasse 20090403

Method GET_INTERFACE_DOCUMENTATION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method GET_PROGRAM_DOCUMENTATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CLASS Call by reference Type reference (TYPE) LTY_PRJ_CLASS Klasse 20090403

Method GET_PROGRAM_DOCUMENTATION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method GET_STRUCTURE_DOCUMENTATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CLASS Call by reference Type reference (TYPE) LTY_PRJ_CLASS Klasse 20090720

Method GET_STRUCTURE_DOCUMENTATION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.

Method SET_CONFIGURATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FILENAME Call by reference Type reference (TYPE) STRING Dateiname 20090403
2 Importing PATH Call by reference Type reference (TYPE) STRING Dateipfad 20090403

Method SET_CONFIGURATION on class CL_UML_CLASS_DECOR_ABAPDOC has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in 720