Skip to content

Commit

Permalink
Update interface names - remove prefix (#153)
Browse files Browse the repository at this point in the history
* Remove Prefix

* Update Docu
  • Loading branch information
wurzka authored Aug 11, 2021
1 parent ecbc90d commit 27ebf7d
Show file tree
Hide file tree
Showing 22 changed files with 32 additions and 32 deletions.
8 changes: 4 additions & 4 deletions doc/specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ The order of these comments is important: First, there is the comment for the ti


## Type Specification Example
Here is the shortened type used to generate the JSON schema for interfaces. It can be found in the interface [`zif_oo_aff_intf_v1`](/file-formats/intf/type/zif_oo_aff_intf_v1.intf.abap).
Here is the shortened type used to generate the JSON schema for interfaces. It can be found in the interface [`zif_aff_intf_v1`](/file-formats/intf/type/zif_aff_intf_v1.intf.abap).
```abap
TYPES:
"! <p class="shorttext">Interface Properties</p>
Expand All @@ -224,14 +224,14 @@ Here is the shortened type used to generate the JSON schema for interfaces. It c
```
With the specification of the component `header` and its used types in the interface [`zif_aff_types_v1`](/file-formats/typesUsedForAll/zif_aff_types_v1.intf.abap)
```abap
"! $values {@link if_aff_types_v1.data:co_abap_language_version_src}
"! $default {@link if_aff_types_v1.data:co_abap_language_version_src.standard}
"! $values {@link zif_aff_types_v1.data:co_abap_language_version_src}
"! $default {@link zif_aff_types_v1.data:co_abap_language_version_src.standard}
TYPES ty_abap_language_version_src TYPE c LENGTH 1.
CONSTANTS:
"! <p class="shorttext">ABAP Language Version (Source Code Objects)</p>
"! ABAP language version for source code objects. For non-source-code objects use
"! {@link if_aff_types_v1.data:ty_abap_language_version }
"! {@link zif_aff_types_v1.data:ty_abap_language_version }
BEGIN OF co_abap_language_version_src,
"! <p class="shorttext">Standard</p>
"! Standard
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
INTERFACE zif_atc_aff_chkc_v1
INTERFACE zif_aff_chkc_v1
PUBLIC.

TYPES:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
INTERFACE zif_atc_aff_chko_v1
INTERFACE zif_aff_chko_v1
PUBLIC.

TYPES:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
INTERFACE zif_atc_aff_chkv_v1
INTERFACE zif_aff_chkv_v1
PUBLIC.

"! <p class="shorttext">Option</p>
"! Option
"! $values {@link zif_atc_aff_chkv_v1.data:co_option}
"! $values {@link zif_aff_chkv_v1.data:co_option}
TYPES ty_option TYPE c LENGTH 2.

CONSTANTS:
Expand Down Expand Up @@ -38,7 +38,7 @@ INTERFACE zif_atc_aff_chkv_v1

"! <p class="shorttext">Sign</p>
"! Sign
"! $values {@link zif_atc_aff_chkv_v1.data:co_sign}
"! $values {@link zif_aff_chkv_v1.data:co_sign}
TYPES ty_sign TYPE c LENGTH 1.

CONSTANTS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
INTERFACE zif_oo_aff_clas_v1 PUBLIC.
INTERFACE zif_aff_clas_v1 PUBLIC.

"! <p class="shorttext">Class Category</p>
"! Category of the class
"! $values {@link zif_oo_aff_clas_v1.data:co_category}
"! $values {@link zif_aff_clas_v1.data:co_category}
TYPES ty_category TYPE n LENGTH 2.

CONSTANTS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
INTERFACE zif_seef_aff_enhs_v1
INTERFACE zif_aff_enhs_v1
PUBLIC.

"! <p class="shorttext">BAdI Enhancement Spot Tool Type</p>
"! Tool type of the BAdI Enhancement Spot
"! $values {@link zif_seef_aff_enhs_v1.data:co_tool}
"! $values {@link zif_aff_enhs_v1.data:co_tool}
TYPES ty_tool TYPE c LENGTH 10.

CONSTANTS:
Expand All @@ -17,7 +17,7 @@ INTERFACE zif_seef_aff_enhs_v1

"! <p class="shorttext">Instantiation of the BAdI Definition</p>
"! Instantiation of the BAdI definition
"! $values {@link zif_seef_aff_enhs_v1.data:co_instantiation}
"! $values {@link zif_aff_enhs_v1.data:co_instantiation}
TYPES ty_instantiation TYPE c LENGTH 1.

CONSTANTS:
Expand All @@ -37,7 +37,7 @@ INTERFACE zif_seef_aff_enhs_v1

"! <p class="shorttext">Filter Type</p>
"! Type of a badi filter
"! $values {@link zif_seef_aff_enhs_v1.data:co_filter_type}
"! $values {@link zif_aff_enhs_v1.data:co_filter_type}
TYPES ty_filter_type TYPE c LENGTH 1.

CONSTANTS:
Expand All @@ -63,7 +63,7 @@ INTERFACE zif_seef_aff_enhs_v1

"! <p class="shorttext">Type of the Value Check Object</p>
"! Type of the value check object
"! $values {@link zif_seef_aff_enhs_v1.data:co_value_check_object_type}
"! $values {@link zif_aff_enhs_v1.data:co_value_check_object_type}
TYPES ty_value_check_object_type TYPE string.

CONSTANTS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
INTERFACE zif_fb_aff_fugr_v1
INTERFACE zif_aff_fugr_v1
PUBLIC.

"! <p class="shorttext">Status</p>
"! status
"! $values {@link zif_fb_aff_fugr.data:co_status}
"! $values {@link zif_aff_fugr.data:co_status}
TYPES ty_status TYPE c LENGTH 1.

CONSTANTS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
INTERFACE zif_fb_aff_func_v1
INTERFACE zif_aff_func_v1
PUBLIC.

TYPES:
Expand All @@ -23,7 +23,7 @@ INTERFACE zif_fb_aff_func_v1

"! <p class="shorttext">Processing Type</p>
"! Processing type
"! $values {@link zif_fb_aff_func_v1.data:co_processing_type}
"! $values {@link zif_aff_func_v1.data:co_processing_type}
TYPES ty_processing_type TYPE c LENGTH 1.

CONSTANTS:
Expand All @@ -44,7 +44,7 @@ INTERFACE zif_fb_aff_func_v1

"! <p class="shorttext">RFC Scope</p>
"! Indicates the scope of function module calls
"! $values {@link zif_fb_aff_func_v1.data:co_rfc_scope}
"! $values {@link zif_aff_func_v1.data:co_rfc_scope}
TYPES ty_rfc_scope TYPE c LENGTH 1.

CONSTANTS:
Expand All @@ -67,7 +67,7 @@ INTERFACE zif_fb_aff_func_v1

"! <p class="shorttext">RFC Version</p>
"! Indicates the permitted serializations for the function module
"! $values {@link zif_fb_aff_func_v1.data:co_rfc_version}
"! $values {@link zif_aff_func_v1.data:co_rfc_version}
TYPES ty_rfc_version TYPE c LENGTH 10.

CONSTANTS:
Expand Down Expand Up @@ -116,7 +116,7 @@ INTERFACE zif_fb_aff_func_v1

"! <p class="shorttext">Update Task Kind</p>
"! Update task kind
"! $values {@link zif_fb_aff_func_v1.data:co_update_task_kind}
"! $values {@link zif_aff_func_v1.data:co_update_task_kind}
TYPES ty_update_task_kind TYPE c LENGTH 1.

CONSTANTS:
Expand All @@ -142,7 +142,7 @@ INTERFACE zif_fb_aff_func_v1

"! <p class="shorttext">Release State</p>
"! Release state
"! $values {@link zif_fb_aff_func_v1.data:co_release_state}
"! $values {@link zif_aff_func_v1.data:co_release_state}
TYPES ty_release_state TYPE c LENGTH 1.

CONSTANTS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
INTERFACE zif_fb_aff_reps_v1
INTERFACE zif_aff_reps_v1
PUBLIC.
"! <p class="shorttext">Include Type</p>
"! Include type
"! $values {@link zif_fb_aff_reps_v1.data:co_include_type}
"! $values {@link zif_aff_reps_v1.data:co_include_type}
TYPES ty_include_type TYPE c LENGTH 1.

CONSTANTS:
Expand Down
2 changes: 1 addition & 1 deletion file-formats/intf/format.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The file with the ending `.abap` contains plain ABAP source code.
The JSON schema for the interface properties file is provided [here](./intf.json).
The ABAP type for the interface properties is provided [here](./zif_aff_intf_v1.intf.abap).
The ABAP type for the interface properties is provided [here](./type/zif_aff_intf_v1.intf.abap).

Example files for an interface `zif_aff_example` are provided in the following table.
File | Content
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
INTERFACE zif_oo_aff_intf_v1 PUBLIC.
INTERFACE zif_aff_intf_v1 PUBLIC.

"! <p class="shorttext">Interface Category</p>
"! Interface category
"! $values {@link zif_oo_aff_intf_v1.data:co_category}
"! $values {@link zif_aff_intf_v1.data:co_category}
TYPES ty_category TYPE n LENGTH 2.

CONSTANTS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
INTERFACE zif_nr_aff_nrob_v1
INTERFACE zif_aff_nrob_v1
PUBLIC.

TYPES:
Expand Down Expand Up @@ -50,7 +50,7 @@ INTERFACE zif_nr_aff_nrob_v1

"! <p class="shorttext">Buffering</p>
"! Choose a buffer type for no buffering, for buffering via main memory or for parallel buffering.
"! $values {@link zif_nr_aff_nrob_v1.data:co_buffering}
"! $values {@link zif_aff_nrob_v1.data:co_buffering}
TYPES ty_buffering TYPE c LENGTH 1.

CONSTANTS:
Expand Down Expand Up @@ -86,7 +86,7 @@ INTERFACE zif_nr_aff_nrob_v1
"! Choose a buffer type for no buffering, for buffering via main memory or for parallel buffering.
"! Default is mainBuffer.
"! $required
"! $default {@link zif_nr_aff_nrob_v1.data:co_buffering.main_buffer}
"! $default {@link zif_aff_nrob_v1.data:co_buffering.main_buffer}
buffering TYPE ty_buffering,
"! <p class="shorttext">Buffered Numbers</p>
"! This value specifies the numbers in buffer. In case of parallel and main memory buffering, add a
Expand Down

0 comments on commit 27ebf7d

Please sign in to comment.