SAP ABAP Class CL_SEDI_ABAP_DOC_CHECK (Check for ABAP Doc correctness)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO-ABA (Application Component) ABAP Editor
     ⤷ SEDI_EXT (Package) Protected Enhancements for Editor

Properties

Class	CL_SEDI_ABAP_DOC_CHECK
Short Description	Check for ABAP Doc correctness
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SEDI_EXT	Protected Enhancements for Editor
Created	20121023	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SEDI_ABAP_DOC_CHECK has no forward declaration.

Interfaces

Class CL_SEDI_ABAP_DOC_CHECK has no interface implemented.

Friends

Class CL_SEDI_ABAP_DOC_CHECK has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	LEVELS	Instance attribute	Private	☐	Type reference (TYPE)	SCAN_CNTX-LEVEL			20121025
2	PROGRAM_NAME	Instance attribute	Private	☐	Type reference (TYPE)	PROGNAME			20121024
3	REPLACING_INCLUDES	Instance attribute	Private	☐	Type reference (TYPE)	SREPTAB			20121025
4	SOURCE	Instance attribute	Private	☐	Type reference (TYPE)	RSWSOURCET			20121024
5	STATEMENTS	Instance attribute	Private	☐	Type reference (TYPE)	SCAN_CNTX-STMNT			20121024
6	TOKENS	Instance attribute	Private	☐	Type reference (TYPE)	SCAN_CNTX-TOKEN			20121024

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK	Instance method	Public	Method		20121024
2	CHECK_ABAP_DOC_COMMAND_CONTENT	Instance method	Private	Method		20121116
3	CHECK_ABAP_DOC_CONTENT	Instance method	Private	Method		20121113
4	CHECK_ABAP_DOC_POSITION	Instance method	Private	Method		20121025
5	CHECK_COMMENT_BLOCK_CONTENT	Instance method	Private	Method		20121119
6	CREATE_INSTANCE	Static method	Public	Method		20121024
7	GET_INCLUDE_BY_STMNT	Instance method	Private	Method		20121025
8	SCAN	Instance method	Private	Method		20121025

Events

Class CL_SEDI_ABAP_DOC_CHECK has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_WARNING	Public	See coding			20121030	begin of ty_warning, "! Name of the include in which the warning occurred incname type rslinlmsg-incname, "! Line in the source code in which the warning occurred line type rslinlmsg-line, "! Column in the source code in which the warning occurred col type rslinlmsg-col, "! Message which warning occurred message type symsg, end of ty_warning
2	TY_WARNINGS	Public	See coding			20121024	ty_warnings type standard table of ty_warning with default key

Method Signatures

Method CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	WARNINGS	Call by reference	☐	Type reference (TYPE)	TY_WARNINGS			20121024

Method CHECK on class CL_SEDI_ABAP_DOC_CHECK has no exception.

Method CHECK_ABAP_DOC_COMMAND_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ABAP_DOC_INFO	Call by reference	☐	Object reference (TYPE REF TO)	LCL_ABAP_DOC_INFO			20121116
2	Importing	LENGTH	Call by reference	☐	Type reference (TYPE)	I			20121116
3	Importing	OFFSET	Call by reference	☐	Type reference (TYPE)	I			20121116
4	Changing	WARNING_LIST	Call by reference	☐	Object reference (TYPE REF TO)	LCL_WARNING_LIST			20121116
5	Importing	XHTML_VALIDATOR	Call by reference	☐	Object reference (TYPE REF TO)	LCL_XHTML_VALIDATOR			20121116

Method CHECK_ABAP_DOC_COMMAND_CONTENT on class CL_SEDI_ABAP_DOC_CHECK has no exception.

Method CHECK_ABAP_DOC_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ABAP_DOC_INFO	Call by reference	☐	Object reference (TYPE REF TO)	LCL_ABAP_DOC_INFO			20121115
2	Changing	WARNING_LIST	Call by reference	☐	Object reference (TYPE REF TO)	LCL_WARNING_LIST			20121114

Method CHECK_ABAP_DOC_CONTENT on class CL_SEDI_ABAP_DOC_CHECK has no exception.

Method CHECK_ABAP_DOC_POSITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ABAP_DOC_STATEMENT	Call by reference	☐	Type reference (TYPE)	SSTMNT			20121025
2	Importing	FIRST_ABAP_DOC_TOKEN	Call by reference	☐	Type reference (TYPE)	STOKES			20121029
3	Importing	STATEMENT_INDEX	Call by reference	☐	Type reference (TYPE)	I			20121030
4	Changing	WARNING_LIST	Call by reference	☐	Object reference (TYPE REF TO)	LCL_WARNING_LIST			20121114

Method CHECK_ABAP_DOC_POSITION on class CL_SEDI_ABAP_DOC_CHECK has no exception.

Method CHECK_COMMENT_BLOCK_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FIRST_ABAP_DOC_TOKEN	Call by reference	☐	Type reference (TYPE)	STOKES			20121119
2	Importing	STATEMENT	Call by reference	☐	Type reference (TYPE)	SSTMNT			20121119
3	Changing	WARNING_LIST	Call by reference	☐	Object reference (TYPE REF TO)	LCL_WARNING_LIST			20121119

Method CHECK_COMMENT_BLOCK_CONTENT on class CL_SEDI_ABAP_DOC_CHECK has no exception.

Method CREATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROGRAM_NAME	Call by reference	☐	Type reference (TYPE)	PROGNAME			20121024
2	Importing	REPLACING_INCLUDES	Call by reference	☑	Type reference (TYPE)	SREPTAB			20121025
3	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SEDI_ABAP_DOC_CHECK			20121024
4	Importing	SOURCE	Call by reference	☐	Type reference (TYPE)	RSWSOURCET			20121024

Method CREATE_INSTANCE on class CL_SEDI_ABAP_DOC_CHECK has no exception.

Method GET_INCLUDE_BY_STMNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	PROGNAME			20121025
2	Importing	STATEMENT	Call by reference	☐	Type reference (TYPE)	SSTMNT			20121025

Method GET_INCLUDE_BY_STMNT on class CL_SEDI_ABAP_DOC_CHECK has no exception.

Method SCAN Signature

Method SCAN on class CL_SEDI_ABAP_DOC_CHECK has no parameter.

#	Exception	Resumable	Description	Created on
1	LCX_SCAN_ERROR	☐		20121025

History

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