SAP ABAP Class CL_OO_SECTION_SOURCE_COMMENTS (Keep comments within class/interface sections)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO-CLA (Application Component) Class Builder
     ⤷ SEOK (Package) ABAP Objects Class Builder Services

Properties

Class	CL_OO_SECTION_SOURCE_COMMENTS
Short Description	Keep comments within class/interface sections
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SEOK	ABAP Objects Class Builder Services
Created	20111109	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

Class CL_OO_SECTION_SOURCE_COMMENTS has no interface implemented.

Friends

Class CL_OO_SECTION_SOURCE_COMMENTS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CLIF_NAME	Instance attribute	Public	☐	Type reference (TYPE)	SEOCLSKEY			20111109
2	TAB_STATEMENTS_OLD	Instance attribute	Private	☐	See coding				20111110
3	TAB_TOKENS_OLD	Instance attribute	Private	☐	See coding				20111110

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Creates an instance of class	20111109
2	EMBED_COMMENT_BLOCKS	Instance method	Public	Method	Embeds the comment blocks in the new section sourcecode	20111109
3	EMBED_COMMENT_END_ROW	Instance method	Public	Method	Embeds comment rows in the new section sourcecode	20111109
4	EMBED_PRAGMAS	Instance method	Public	Method	Embeds comment rows in the new section sourcecode	20111212
5	IDENTIFY_COMMENT_BLOCKS	Instance method	Public	Method	Indentifies the comments within a section sourcecode	20111109
6	IDENTIFY_COMMENT_END_ROW	Instance method	Public	Method	Indentifies the comments within a section sourcecode	20111109
7	IDENTIFY_PRAGMAS	Instance method	Public	Method	Indentifies the comments within a section sourcecode	20111212
8	INSERT_DOC_FOR_CMPKEY	Instance method	Public	Method	Inserts comment block for a component	20111109
9	IS_WITHIN_DATA_BEGIN_END_OF	Instance method	Private	Method	Is the comment contained within begin of ... end of...	20111109
10	IS_WITHIN_TYPES_BEGIN_END_OF	Instance method	Private	Method		20111109
11	REMOVE_DUPLICATE_COMMENT_TOKEN	Instance method	Private	Method		20111220
12	SCAN_CODE	Instance method	Public	Method	Scans the section sourcecode	20111109

Events

Class CL_OO_SECTION_SOURCE_COMMENTS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_COMMENTS_FOR_CMPNAMES	Public	See coding			20111109	ty_comments_for_cmpnames type table of ty_comment_for_cmpname
2	TY_COMMENT_BLOCK	Public	See coding			20111109	begin of ty_comment_block, tab_comments type seo_section_source, column_first_comment type i, hook_relevant_tok_type type stokesx, hook_relevant_tok_name type stokesx, hook_relevant_tok_name_add type stokesx, hook_relevant_tok_type_stmnt type stokesx, hook_relevant_tok_name_stmnt type stokesx, end of ty_comment_block
3	TY_COMMENT_BLOCKS	Public	See coding			20111109	ty_comment_blocks type table of ty_comment_block
4	TY_COMMENT_FOR_CMPNAME	Public	See coding			20111109	begin of ty_comment_for_cmpname, cmpname type seocmpname, tab_comments type seo_section_source, end of ty_comment_for_cmpname
5	TY_SSTMNT	Public	See coding			20111109	ty_sstmnt type table of sstmnt
6	TY_STOKESX	Public	See coding			20111109	ty_stokesx type standard table of stokesx

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIFKEY	Call by reference	☐	Type reference (TYPE)	SEOCLSKEY			20111109

Method CONSTRUCTOR on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method EMBED_COMMENT_BLOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	TAB_SOURCE_NEW	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111109
2	Importing	TAB_SOURCE_OLD	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111109

Method EMBED_COMMENT_BLOCKS on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method EMBED_COMMENT_END_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	TAB_SOURCE_NEW	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111109
2	Importing	TAB_SOURCE_OLD	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111109

Method EMBED_COMMENT_END_ROW on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method EMBED_PRAGMAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	TAB_SOURCE_NEW	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111212
2	Importing	TAB_SOURCE_OLD	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111212

Method EMBED_PRAGMAS on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method IDENTIFY_COMMENT_BLOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	TAB_COMMENTS	Call by reference	☐	Type reference (TYPE)	TY_COMMENT_BLOCKS			20111109
2	Importing	TAB_SOURCE	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111109
3	Importing	TAB_STATEMENTS	Call by reference	☐	Type reference (TYPE)	TY_SSTMNT			20111109
4	Importing	TAB_TOKENS	Call by reference	☐	Type reference (TYPE)	TY_STOKESX			20111109

Method IDENTIFY_COMMENT_BLOCKS on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method IDENTIFY_COMMENT_END_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	TAB_COMMENTS	Call by reference	☐	Type reference (TYPE)	TY_COMMENT_BLOCKS			20111109
2	Importing	TAB_SOURCE	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111109
3	Importing	TAB_STATEMENTS	Call by reference	☐	Type reference (TYPE)	TY_SSTMNT			20111109
4	Importing	TAB_TOKENS	Call by reference	☐	Type reference (TYPE)	TY_STOKESX			20111109

Method IDENTIFY_COMMENT_END_ROW on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method IDENTIFY_PRAGMAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	TAB_COMMENTS	Call by reference	☐	Type reference (TYPE)	TY_COMMENT_BLOCKS			20111212
2	Importing	TAB_SOURCE	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111212
3	Importing	TAB_STATEMENTS	Call by reference	☐	Type reference (TYPE)	TY_SSTMNT			20111212
4	Importing	TAB_TOKENS	Call by reference	☐	Type reference (TYPE)	TY_STOKESX			20111212

Method IDENTIFY_PRAGMAS on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method INSERT_DOC_FOR_CMPKEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TAB_COMPONENT_DOC	Call by reference	☐	Type reference (TYPE)	TY_COMMENTS_FOR_CMPNAMES			20111109
2	Changing	TAB_SOURCE	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111109

Method INSERT_DOC_FOR_CMPKEY on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method IS_WITHIN_DATA_BEGIN_END_OF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LIMIT	Value transfer	☐	Type reference (TYPE)	I			20111109
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20111109
3	Importing	TAB_STATEMENTS	Value transfer	☐	Type reference (TYPE)	CL_OO_SECTION_SOURCE_COMMENTS=>TY_SSTMNT			20111109
4	Importing	TAB_TOKENS	Value transfer	☐	Type reference (TYPE)	CL_OO_SECTION_SOURCE_COMMENTS=>TY_STOKESX			20111109

Method IS_WITHIN_DATA_BEGIN_END_OF on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method IS_WITHIN_TYPES_BEGIN_END_OF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LIMIT	Value transfer	☐	Type reference (TYPE)	I			20111109
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20111109
3	Importing	TAB_STATEMENTS	Value transfer	☐	Type reference (TYPE)	CL_OO_SECTION_SOURCE_COMMENTS=>TY_SSTMNT			20111109
4	Importing	TAB_TOKENS	Value transfer	☐	Type reference (TYPE)	CL_OO_SECTION_SOURCE_COMMENTS=>TY_STOKESX			20111109

Method IS_WITHIN_TYPES_BEGIN_END_OF on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method REMOVE_DUPLICATE_COMMENT_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	TAB_TOKENS	Call by reference	☐	Type reference (TYPE)	CL_OO_SECTION_SOURCE_COMMENTS=>TY_STOKESX			20111220

Method REMOVE_DUPLICATE_COMMENT_TOKEN on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

Method SCAN_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SOURCE_TO_BE_SCANNED	Call by reference	☐	Type reference (TYPE)	SEO_SECTION_SOURCE			20111109
2	Exporting	TAB_STATEMENTS	Call by reference	☐	Type reference (TYPE)	TY_SSTMNT			20111109
3	Exporting	TAB_TOKENS	Call by reference	☐	Type reference (TYPE)	TY_STOKESX			20111109

Method SCAN_CODE on class CL_OO_SECTION_SOURCE_COMMENTS has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	740