From 536d307358faa2f7dd6cca26670e35d8f48beccd Mon Sep 17 00:00:00 2001 From: chaitanyavalli-r Date: Wed, 27 Mar 2024 14:13:38 +0530 Subject: [PATCH 1/2] RIC-876: Added macros for missing TargetRTS documentation --- rtistic-pub-doc_doxyfile | 56 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 53 insertions(+), 3 deletions(-) diff --git a/rtistic-pub-doc_doxyfile b/rtistic-pub-doc_doxyfile index e424d14..4e164fd 100644 --- a/rtistic-pub-doc_doxyfile +++ b/rtistic-pub-doc_doxyfile @@ -2086,6 +2086,7 @@ MACRO_EXPANSION = YES # EXPAND_AS_DEFINED tags. # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. +# This can be useful to avoid expanding macros from external headers. EXPAND_ONLY_PREDEF = YES @@ -2119,7 +2120,30 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = RTS_INLINE= +PREDEFINED = RTS_INLINE= \ + RTUseCPP11= \ + OBJECT_ENCODE= \ + OBJECT_DECODE= \ + RTAsciiEncoding + HAVE_INET= \ + INTEGER_POSTFIX= \ + LOG_MESSAGE= \ + OBJECT_DECODE= \ + OBJECT_ENCODE= \ + RTS_COMPATIBLE= \ + RTS_INLINES= \ + RTFRAME_CHECKING=RTFRAME_CHECK_STRICT \ + RTIMPORT_ISREFERENCEDBY_CHECK= \ + RTFRAME_THREAD_SAFE= \ + RTMESSAGE_PAYLOAD_SIZE= \ + RTUseFloatingPoint= \ + RTREAL_INCLUDED=RTUseFloatingPoint \ + RTTYPECHECK_PROTOCOL=RTTYPECHECK_WARN \ + RTTYPECHECK_SEND=RTTYPECHECK_WARN \ + INLINE_METHODS= \ + INLINE_CHAINS= \ + OBSERVABLE= \ + override= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The @@ -2128,7 +2152,33 @@ PREDEFINED = RTS_INLINE= # definition found in the source code. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_AS_DEFINED = RTS_INLINE +EXPAND_AS_DEFINED = RTS_INLINE \ + RTFRAME_CHECKING \ + RTUseCPP11= \ + OBJECT_ENCODE= \ + OBJECT_DECODE= \ + RTAsciiEncoding + HAVE_INET= \ + INTEGER_POSTFIX= \ + LOG_MESSAGE= \ + OBJECT_DECODE= \ + OBJECT_ENCODE= \ + RTS_COMPATIBLE= \ + RTS_INLINES= \ + RTFRAME_CHECKING=RTFRAME_CHECK_STRICT \ + RTIMPORT_ISREFERENCEDBY_CHECK= \ + RTFRAME_THREAD_SAFE= \ + RTMESSAGE_PAYLOAD_SIZE= \ + RTUseFloatingPoint= \ + RTREAL_INCLUDED=RTUseFloatingPoint \ + RTTYPECHECK_PROTOCOL=RTTYPECHECK_WARN \ + RTTYPECHECK_SEND=RTTYPECHECK_WARN \ + INLINE_METHODS= \ + INLINE_CHAINS= \ + OBSERVABLE= \ + override= \ + USE_THREADS= \ + # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will # remove all references to function-like macros that are alone on a line, have @@ -2509,4 +2559,4 @@ GENERATE_LEGEND = YES # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_CLEANUP = YES \ No newline at end of file +DOT_CLEANUP = YES From addaf0d11263bf68c36a97d066e181cc9486cf3e Mon Sep 17 00:00:00 2001 From: jenkins Date: Wed, 27 Mar 2024 08:45:02 +0000 Subject: [PATCH 2/2] C++ TargetRTS generated doc. merge | build 33 | for commit: [536d307358faa2f7dd6cca26670e35d8f48beccd] --- .../_r_t_actor_factory_8h_source.html | 9 +- .../_r_t_actor_ref_8h_source.html | 2 +- .../_r_t_ascii_decoding_8h_source.html | 17 +- .../_r_t_ascii_encoding_8h_source.html | 3 +- .../_r_t_data_object_8h_source.html | 10 +- .../_r_t_decoding_8h_source.html | 11 +- .../_r_t_encoding_8h_source.html | 11 +- .../_r_t_enumerated_8h_source.html | 6 +- .../_r_t_field_descriptor_8h_source.html | 10 +- .../targetrts-api/_r_t_frame_8h_source.html | 12 +- .../_r_t_json_decoding_8h_source.html | 3 +- .../targetrts-api/_r_t_log_8h_source.html | 6 +- .../_r_t_object__class_8h_source.html | 41 +- .../_r_t_unknown_object_8h_source.html | 3 +- .../_r_t_v_ascii_decoding_8h_source.html | 12 +- .../_r_t_v_ascii_encoding_8h_source.html | 11 +- docs-sources/targetrts-api/annotated.html | 334 +++--- .../class_exception_1_1_base.html | 16 +- .../class_external_1_1_base.html | 16 +- .../class_frame_1_1_base-members.html | 4 + .../targetrts-api/class_frame_1_1_base.html | 124 ++- .../class_log_1_1_base-members.html | 100 +- .../targetrts-api/class_log_1_1_base.html | 220 +++- .../class_r_t_abort_controller.html | 4 +- .../class_r_t_actor_factory-members.html | 2 +- .../class_r_t_actor_factory.html | 34 +- .../class_r_t_actor_id-members.html | 25 +- .../targetrts-api/class_r_t_actor_id.html | 19 + .../class_r_t_ascii_decoding-members.html | 124 +++ .../class_r_t_ascii_decoding.html | 987 ++++++++++++++++++ .../class_r_t_ascii_decoding.png | Bin 0 -> 752 bytes .../class_r_t_boolean-members.html | 29 +- .../targetrts-api/class_r_t_boolean.html | 16 + .../class_r_t_byte_block-members.html | 25 +- .../targetrts-api/class_r_t_byte_block.html | 19 + .../class_r_t_character-members.html | 33 +- .../targetrts-api/class_r_t_character.html | 19 + .../targetrts-api/class_r_t_controller.html | 4 +- .../class_r_t_custom_controller.html | 4 +- .../class_r_t_data_object-members.html | 15 +- .../targetrts-api/class_r_t_data_object.html | 19 + .../class_r_t_decoding-members.html | 109 ++ .../targetrts-api/class_r_t_decoding.html | 170 +++ .../targetrts-api/class_r_t_decoding.png | Bin 0 -> 758 bytes .../class_r_t_diag_stream-members.html | 3 +- .../targetrts-api/class_r_t_diag_stream.html | 3 + .../class_r_t_encoding-members.html | 111 ++ .../targetrts-api/class_r_t_encoding.html | 166 +++ .../class_r_t_enumerated-members.html | 27 +- .../targetrts-api/class_r_t_enumerated.html | 19 + .../targetrts-api/class_r_t_i_o_monitor.html | 4 +- .../class_r_t_integer-members.html | 23 +- .../targetrts-api/class_r_t_integer.html | 19 + .../targetrts-api/class_r_t_message.html | 18 +- .../class_r_t_peer_controller.html | 4 +- .../class_r_t_pointer-members.html | 31 +- .../targetrts-api/class_r_t_pointer.html | 16 + .../class_r_t_priority-members.html | 37 +- .../targetrts-api/class_r_t_priority.html | 20 +- .../targetrts-api/class_r_t_protocol.html | 8 +- .../class_r_t_root_protocol.html | 16 +- .../class_r_t_sequence-members.html | 21 +- .../targetrts-api/class_r_t_sequence.html | 19 + .../class_r_t_sequence_of-members.html | 27 +- .../targetrts-api/class_r_t_sequence_of.html | 19 + .../class_r_t_signal-members.html | 29 +- .../targetrts-api/class_r_t_signal.html | 16 + .../class_r_t_sole_controller.html | 4 +- .../class_r_t_string-members.html | 25 +- .../targetrts-api/class_r_t_string.html | 25 + .../targetrts-api/class_r_t_super_actor.html | 4 +- .../targetrts-api/class_r_t_tcp_socket.html | 4 +- .../targetrts-api/class_r_t_time-members.html | 35 +- .../targetrts-api/class_r_t_time.html | 16 + .../class_r_t_timer_controller.html | 4 +- .../class_r_t_v_ascii_decoding-members.html | 126 +++ .../class_r_t_v_ascii_decoding.html | 307 ++++++ .../class_r_t_v_ascii_decoding.png | Bin 0 -> 746 bytes .../class_r_t_v_ascii_encoding-members.html | 87 ++ .../class_r_t_v_ascii_encoding.html | 101 ++ .../class_timing_1_1_base-members.html | 12 + .../targetrts-api/class_timing_1_1_base.html | 53 +- docs-sources/targetrts-api/classes.html | 2 +- docs-sources/targetrts-api/functions.html | 2 + docs-sources/targetrts-api/functions_d.html | 1 + docs-sources/targetrts-api/functions_e.html | 1 + .../targetrts-api/functions_func_d.html | 1 + .../targetrts-api/functions_func_e.html | 1 + .../targetrts-api/functions_func_i.html | 1 + .../targetrts-api/functions_func_l.html | 1 + .../targetrts-api/functions_func_r.html | 1 + docs-sources/targetrts-api/functions_i.html | 1 + docs-sources/targetrts-api/functions_l.html | 1 + docs-sources/targetrts-api/functions_r.html | 1 + .../targetrts-api/functions_vars.html | 2 + docs-sources/targetrts-api/hierarchy.html | 280 ++--- docs-sources/targetrts-api/search/all_0.js | 34 +- docs-sources/targetrts-api/search/all_10.js | 4 +- docs-sources/targetrts-api/search/all_4.js | 25 +- docs-sources/targetrts-api/search/all_5.js | 11 +- docs-sources/targetrts-api/search/all_8.js | 59 +- docs-sources/targetrts-api/search/all_a.js | 3 +- docs-sources/targetrts-api/search/all_f.js | 276 ++--- .../targetrts-api/search/classes_7.js | 248 ++--- .../targetrts-api/search/functions_3.js | 23 +- .../targetrts-api/search/functions_4.js | 3 +- .../targetrts-api/search/functions_7.js | 55 +- .../targetrts-api/search/functions_9.js | 3 +- .../targetrts-api/search/functions_e.js | 21 +- .../targetrts-api/search/functions_f.js | 2 +- .../targetrts-api/search/variables_0.js | 34 +- .../struct_r_t_array__class-members.html | 27 +- .../struct_r_t_array__class.html | 17 + .../struct_r_t_cached_string_1_1_block.html | 4 +- .../struct_r_t_field_descriptor-members.html | 4 +- .../struct_r_t_field_descriptor.html | 6 + .../struct_r_t_large_optional.html | 14 +- .../struct_r_t_message_block.html | 4 +- .../struct_r_t_object__class-members.html | 23 +- .../struct_r_t_object__class.html | 130 ++- .../struct_r_t_port_descriptor.html | 8 +- .../struct_r_t_queue_1_1_block.html | 4 +- ..._r_t_typed_value___r_t_string-members.html | 5 +- .../struct_r_t_typed_value___r_t_string.html | 9 + .../struct_r_t_unknown_object-members.html | 88 ++ .../struct_r_t_unknown_object.html | 107 ++ 126 files changed, 4572 insertions(+), 1072 deletions(-) create mode 100644 docs-sources/targetrts-api/class_r_t_ascii_decoding-members.html create mode 100644 docs-sources/targetrts-api/class_r_t_ascii_decoding.html create mode 100644 docs-sources/targetrts-api/class_r_t_ascii_decoding.png create mode 100644 docs-sources/targetrts-api/class_r_t_decoding-members.html create mode 100644 docs-sources/targetrts-api/class_r_t_decoding.html create mode 100644 docs-sources/targetrts-api/class_r_t_decoding.png create mode 100644 docs-sources/targetrts-api/class_r_t_encoding-members.html create mode 100644 docs-sources/targetrts-api/class_r_t_encoding.html create mode 100644 docs-sources/targetrts-api/class_r_t_v_ascii_decoding-members.html create mode 100644 docs-sources/targetrts-api/class_r_t_v_ascii_decoding.html create mode 100644 docs-sources/targetrts-api/class_r_t_v_ascii_decoding.png create mode 100644 docs-sources/targetrts-api/class_r_t_v_ascii_encoding-members.html create mode 100644 docs-sources/targetrts-api/class_r_t_v_ascii_encoding.html create mode 100644 docs-sources/targetrts-api/struct_r_t_unknown_object-members.html create mode 100644 docs-sources/targetrts-api/struct_r_t_unknown_object.html diff --git a/docs-sources/targetrts-api/_r_t_actor_factory_8h_source.html b/docs-sources/targetrts-api/_r_t_actor_factory_8h_source.html index bcaa9da..8738091 100644 --- a/docs-sources/targetrts-api/_r_t_actor_factory_8h_source.html +++ b/docs-sources/targetrts-api/_r_t_actor_factory_8h_source.html @@ -99,14 +99,14 @@
21
25#if RTUseCPP11
26#include <functional>
-
27class RTActorFactory final : public RTActorFactoryInterface {
+
28 RTActorFactory() = delete;
29 std::function<RTActor* (RTController *, RTActorRef *, int)> creator;
30public:
-
35 RTActorFactory(std::function<RTActor* (RTController *, RTActorRef *, int)> createFunc);
+
35 RTActorFactory(std::function<RTActor* (RTController *, RTActorRef *, int)> createFunc);
36#else
37 /* An old C++ compiler can compile this code, but not use RTActorFactory */
- +
39public:
41#endif
@@ -117,9 +117,10 @@
46};
47
48#endif // __RTActorFactory_h__
-
A capsule factory where capsule instances are created by means of a provided 'create' function,...
Definition: RTActorFactory.h:38
+
A capsule factory where capsule instances are created by means of a provided 'create' function,...
Definition: RTActorFactory.h:27
RTActor * create(RTController *rts, RTActorRef *ref, int index) override
Called by the TargetRTS to create a capsule instance, which later will be inserted into a capsule par...
void destroy(RTActor *actor) override
Called by the TargetRTS to destroy a capsule instance.
+
RTActorFactory(std::function< RTActor *(RTController *, RTActorRef *, int)> createFunc)
Create a capsule factory which will use the provided function to implement capsule instance creation.
Interface of a capsule factory responsible for creating and destroying capsule instances in a capsule...
Definition: RTActorFactoryInterface.h:15
An instance of this class represents a capsule instance.
Definition: RTActor.h:44
Represents a capsule part.
Definition: RTActorRef.h:39
diff --git a/docs-sources/targetrts-api/_r_t_actor_ref_8h_source.html b/docs-sources/targetrts-api/_r_t_actor_ref_8h_source.html index 0cb9733..c31fb38 100644 --- a/docs-sources/targetrts-api/_r_t_actor_ref_8h_source.html +++ b/docs-sources/targetrts-api/_r_t_actor_ref_8h_source.html @@ -216,7 +216,7 @@
241#endif
242
243#endif // __RTActorRef_h__
-
A capsule factory where capsule instances are created by means of a provided 'create' function,...
Definition: RTActorFactory.h:38
+
A capsule factory where capsule instances are created by means of a provided 'create' function,...
Definition: RTActorFactory.h:27
Interface of a capsule factory responsible for creating and destroying capsule instances in a capsule...
Definition: RTActorFactoryInterface.h:15
An instance of this class represents a capsule instance.
Definition: RTActor.h:44
An object that identifies a capsule instance at run-time.
Definition: RTActorId.h:27
diff --git a/docs-sources/targetrts-api/_r_t_ascii_decoding_8h_source.html b/docs-sources/targetrts-api/_r_t_ascii_decoding_8h_source.html index 65fde47..8d09e1f 100644 --- a/docs-sources/targetrts-api/_r_t_ascii_decoding_8h_source.html +++ b/docs-sources/targetrts-api/_r_t_ascii_decoding_8h_source.html @@ -100,13 +100,13 @@
22
23class RTDataObject;
24class RTIBuffer;
-
25struct RTUnknownObject;
+
25struct RTUnknownObject;
26
-
31class RTAsciiDecoding : public RTDecoding
+
32{
33public:
-
34 explicit RTAsciiDecoding( RTIBuffer * );
-
35 virtual ~RTAsciiDecoding( void );
+
34 explicit RTAsciiDecoding( RTIBuffer * );
+
35 virtual ~RTAsciiDecoding( void );
36
37 // All the get/put functions return an int which is non-zero
38 // if the operation was successful. Otherwise, the following
@@ -163,7 +163,7 @@
89 int getArray( void *, int, const RTObject_class * );
90 int getAddress ( void * & );
91 int getName( char * value, int length );
-
92 RTUnknownObject * getUnknown( const char * );
+
92 RTUnknownObject * getUnknown( const char * );
93
94 int getNonWhite( char & );
95 int getByte( char & );
@@ -182,17 +182,20 @@
108 RTIBuffer * input;
109
110 // unavailable methods
-
111 RTAsciiDecoding( const RTAsciiDecoding & );
-
112 RTAsciiDecoding & operator=( const RTAsciiDecoding & );
+ +
112 RTAsciiDecoding & operator=( const RTAsciiDecoding & );
113}; //lint !e1712
114
115#endif // OBJECT_DECODE
116
117#endif // __RTAsciiDecoding_h__
+
The default decoding implementation that is used for all default type descriptors.
Definition: RTAsciiDecoding.h:32
Provides a common interface to certain data type implementations (e.g.
Definition: RTDataObject.h:33
+
Definition: RTDecoding.h:27
Definition: RTIBuffer.h:22
Definition: RTFieldDescriptor.h:40
A type descriptor providing information about a type.
Definition: RTObject_class.h:64
+
Definition: RTUnknownObject.h:24