Skip to content

Commit ac4070a

Browse files
richiwareEduPonz
richiware
authored and
EduPonz
committed
Fix warning generating documentation for 3.0.x (#121)
* Refs #20631. Fix warning generating documentation Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev> Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20631. Fix warnings Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev> Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20631. Fix warnings Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev> Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev> Signed-off-by: eduponz <eduardoponz@eprosima.com>
1 parent 334fa3c commit ac4070a

31 files changed

Lines changed: 137 additions & 450 deletions

‎fastdds_python.repos‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ repositories:
1010
fastdds:
1111
type: git
1212
url: https://github.com/eProsima/Fast-DDS.git
13-
version: master
13+
version: 3.0.x-devel
1414
fastdds_python:
1515
type: git
1616
url: https://github.com/eProsima/Fast-DDS-python.git
1717
version: main
1818
fastddsgen:
1919
type: git
2020
url: https://github.com/eProsima/Fast-DDS-Gen.git
21-
version: master
21+
version: 4.0.x-devel

‎fastdds_python/src/swig/fastdds.i‎

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ bool has_statistics();
8989

9090
// Macro delcarations
9191
// Any macro used on the Fast DDS header files will give an error if it is not redefined here
92+
#define eProsima_user_DllExport
9293
#define FASTDDS_EXPORTED_API
9394
#define FASTDDS_DEPRECATED_UNTIL(major, entity_name, msg)
9495
#define FASTDDS_TODO_BEFORE(major, minor, msg)
@@ -312,28 +313,6 @@ namespace xtypes {
312313
%include "fastrtps/qos/LivelinessLostStatus.i"
313314
%include "fastrtps/qos/LivelinessChangedStatus.i"
314315
%include "fastrtps/qos/SampleRejectedStatus.i"
315-
%include "fastrtps/types/DynamicDataFactory.i"
316-
%include "fastrtps/types/DynamicType.i"
317-
%include "fastrtps/types/TypeNamesGenerator.i"
318-
%include "fastrtps/types/AnnotationDescriptor.i"
319-
%include "fastrtps/types/TypeDescriptor.i"
320-
%include "fastrtps/types/DynamicDataPtr.i"
321-
%include "fastrtps/types/DynamicTypeBuilder.i"
322-
%include "fastrtps/types/DynamicTypeBuilderFactory.i"
323-
%include "fastrtps/types/TypeObjectHashId.i"
324-
%include "fastrtps/types/TypeObject.i"
325-
%include "fastrtps/types/BuiltinAnnotationsTypeObject.i"
326-
%include "fastrtps/types/DynamicDataHelper.i"
327-
%include "fastrtps/types/DynamicTypeBuilderPtr.i"
328-
%include "fastrtps/types/TypeIdentifier.i"
329-
%include "fastrtps/types/DynamicData.i"
330-
%include "fastrtps/types/MemberDescriptor.i"
331-
%include "fastrtps/types/TypeIdentifierTypes.i"
332-
%include "fastrtps/types/DynamicTypeMember.i"
333-
%include "fastrtps/types/AnnotationParameterValue.i"
334-
%include "fastrtps/types/TypeObjectFactory.i"
335-
%include "fastrtps/types/DynamicTypePtr.i"
336-
%include "fastrtps/types/DynamicPubSubType.i"
337316
%include "fastrtps/config/doxygen_modules.i"
338317
%include "fastrtps/log/Log.i"
339318
%include "fastrtps/log/StdoutConsumer.i"
@@ -496,6 +475,7 @@ namespace xtypes {
496475
%include "fastdds/dds/domain/qos/RequesterQos.i"
497476
%include "fastdds/dds/domain/DomainParticipant.i"
498477
%include "fastdds/dds/domain/DomainParticipantFactory.i"
478+
%include "fastdds/dds/xtypes/type_representation/TypeObject.i"
499479

500480
// Log functionality not available in the bind
501481
// Logs in the library is still available, only 'Log' class will not be available on Python

‎fastdds_python/src/swig/fastdds/dds/common/InstanceHandle.i‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,4 @@
1616
#include "fastdds/dds/common/InstanceHandle.hpp"
1717
%}
1818

19-
2019
%include "fastdds/dds/common/InstanceHandle.hpp"

‎fastdds_python/src/swig/fastdds/dds/domain/DomainParticipant.i‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,4 +288,8 @@
288288
%ignore eprosima::fastdds::dds::DomainParticipant::delete_subscriber;
289289
%ignore eprosima::fastdds::dds::DomainParticipant::create_subscriber_with_profile;
290290

291+
// Template for std::vector<DomainParticipant*>
292+
%template(DomainParticipantVector) std::vector<eprosima::fastdds::dds::DomainParticipant*>;
293+
%typemap(doctype) std::vector<eprosima::fastdds::dds::DomainParticipant*> "DomainParticipantVector";
294+
291295
%include "fastdds/dds/domain/DomainParticipant.hpp"

‎fastdds_python/src/swig/fastdds/dds/domain/DomainParticipantFactory.i‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@
1616
#include "fastdds/dds/domain/DomainParticipantFactory.hpp"
1717
%}
1818

19-
/*
20-
%extend eprosima::fastdds::dds::DomainParticipantFactory
21-
{
22-
}
23-
*/
2419
%extend eprosima::fastdds::dds::DomainParticipantFactory
2520
{
2621
/**

‎fastdds_python/src/swig/fastdds/dds/publisher/DataWriter.i‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@
2424
const fastrtps::rtps::Time_t&);
2525
%ignore eprosima::fastdds::dds::DataWriter::unregister_instance_w_timestamp(void*, const InstanceHandle_t&,
2626
const fastrtps::rtps::Time_t&);
27-
%ignore eprosima::fastdds::dds::DataWriter::get_matched_subscriptions(
28-
std::vector<InstanceHandle_t*>&) const;
2927

3028
// Unsupported function on Python are ignored
3129
%ignore loan_sample(void*&, LoanInitializationKind);
@@ -125,6 +123,7 @@
125123

126124
// Template for std::vector<DataWriter*>
127125
%template(DataWriterVector) std::vector<eprosima::fastdds::dds::DataWriter*>;
126+
%typemap(doctype) std::vector<eprosima::fastdds::dds::DataWriter*> "DataWriterVector";
128127

129128
%include "fastdds/dds/publisher/DataWriter.hpp"
130129

‎fastdds_python/src/swig/fastdds/dds/subscriber/DataReader.i‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@
1818

1919
// Template for std::vector<DataReader*>
2020
%template(DataReaderVector) std::vector<eprosima::fastdds::dds::DataReader*>;
21+
%typemap(doctype) std::vector<eprosima::fastdds::dds::DataReader*> "DataReaderVector";
22+
2123
%template(SampleInfoSeq) eprosima::fastdds::dds::LoanableSequence<eprosima::fastdds::dds::SampleInfo>;
24+
%typemap(doctype) eprosima::fastdds::dds::LoanableSequence<eprosima::fastdds::dds::SampleInfo> "SampleInfoSeq";
2225
%extend eprosima::fastdds::dds::LoanableSequence<eprosima::fastdds::dds::SampleInfo>
2326
{
2427
size_t __len__() const

‎fastdds_python/src/swig/fastdds/dds/xtypes/type_representation/TypeObject.i‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
// Copyright 2024 Proyectos y Sistemas de Mantenimiento SL (eProsima).
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
%{
16+
#include "fastdds/dds/xtypes/type_representation/detail/dds_xtypes_typeobject.hpp"
17+
%}
18+
19+
%ignore eprosima::fastdds::dds::xtypes::TypeObjectHashId;
20+
%ignore eprosima::fastdds::dds::xtypes::StringSTypeDefn;
21+
%ignore eprosima::fastdds::dds::xtypes::StringLTypeDefn;
22+
%ignore eprosima::fastdds::dds::xtypes::PlainCollectionHeader;
23+
%ignore eprosima::fastdds::dds::xtypes::PlainSequenceSElemDefn;
24+
%ignore eprosima::fastdds::dds::xtypes::PlainSequenceLElemDefn;
25+
%ignore eprosima::fastdds::dds::xtypes::PlainArraySElemDefn;
26+
%ignore eprosima::fastdds::dds::xtypes::PlainArrayLElemDefn;
27+
%ignore eprosima::fastdds::dds::xtypes::PlainMapSTypeDefn;
28+
%ignore eprosima::fastdds::dds::xtypes::PlainMapLTypeDefn;
29+
%ignore eprosima::fastdds::dds::xtypes::StronglyConnectedComponentId;
30+
%ignore eprosima::fastdds::dds::xtypes::ExtendedTypeDefn;
31+
%ignore eprosima::fastdds::dds::xtypes::TypeIdentifier;
32+
%ignore eprosima::fastdds::dds::xtypes::ExtendedAnnotationParameterValue;
33+
%ignore eprosima::fastdds::dds::xtypes::AnnotationParameterValue;
34+
%ignore eprosima::fastdds::dds::xtypes::AppliedAnnotationParameter;
35+
%ignore eprosima::fastdds::dds::xtypes::AppliedAnnotation;
36+
%ignore eprosima::fastdds::dds::xtypes::AppliedVerbatimAnnotation;
37+
%ignore eprosima::fastdds::dds::xtypes::AppliedBuiltinMemberAnnotations;
38+
%ignore eprosima::fastdds::dds::xtypes::CommonStructMember;
39+
%ignore eprosima::fastdds::dds::xtypes::CompleteMemberDetail;
40+
%ignore eprosima::fastdds::dds::xtypes::MinimalMemberDetail;
41+
%ignore eprosima::fastdds::dds::xtypes::CompleteStructMember;
42+
%ignore eprosima::fastdds::dds::xtypes::MinimalStructMember;
43+
%ignore eprosima::fastdds::dds::xtypes::AppliedBuiltinTypeAnnotations;
44+
%ignore eprosima::fastdds::dds::xtypes::MinimalTypeDetail;
45+
%ignore eprosima::fastdds::dds::xtypes::CompleteTypeDetail;
46+
%ignore eprosima::fastdds::dds::xtypes::CompleteStructHeader;
47+
%ignore eprosima::fastdds::dds::xtypes::MinimalStructHeader;
48+
%ignore eprosima::fastdds::dds::xtypes::CompleteStructType;
49+
%ignore eprosima::fastdds::dds::xtypes::MinimalStructType;
50+
%ignore eprosima::fastdds::dds::xtypes::CommonUnionMember;
51+
%ignore eprosima::fastdds::dds::xtypes::CompleteUnionMember;
52+
%ignore eprosima::fastdds::dds::xtypes::MinimalUnionMember;
53+
%ignore eprosima::fastdds::dds::xtypes::CommonDiscriminatorMember;
54+
%ignore eprosima::fastdds::dds::xtypes::CompleteDiscriminatorMember;
55+
%ignore eprosima::fastdds::dds::xtypes::MinimalDiscriminatorMember;
56+
%ignore eprosima::fastdds::dds::xtypes::CompleteUnionHeader;
57+
%ignore eprosima::fastdds::dds::xtypes::MinimalUnionHeader;
58+
%ignore eprosima::fastdds::dds::xtypes::CompleteUnionType;
59+
%ignore eprosima::fastdds::dds::xtypes::MinimalUnionType;
60+
%ignore eprosima::fastdds::dds::xtypes::CommonAnnotationParameter;
61+
%ignore eprosima::fastdds::dds::xtypes::CompleteAnnotationParameter;
62+
%ignore eprosima::fastdds::dds::xtypes::MinimalAnnotationParameter;
63+
%ignore eprosima::fastdds::dds::xtypes::CompleteAnnotationHeader;
64+
%ignore eprosima::fastdds::dds::xtypes::MinimalAnnotationHeader;
65+
%ignore eprosima::fastdds::dds::xtypes::CompleteAnnotationType;
66+
%ignore eprosima::fastdds::dds::xtypes::MinimalAnnotationType;
67+
%ignore eprosima::fastdds::dds::xtypes::CommonAliasBody;
68+
%ignore eprosima::fastdds::dds::xtypes::CompleteAliasBody;
69+
%ignore eprosima::fastdds::dds::xtypes::MinimalAliasBody;
70+
%ignore eprosima::fastdds::dds::xtypes::CompleteAliasHeader;
71+
%ignore eprosima::fastdds::dds::xtypes::MinimalAliasHeader;
72+
%ignore eprosima::fastdds::dds::xtypes::CompleteAliasType;
73+
%ignore eprosima::fastdds::dds::xtypes::MinimalAliasType;
74+
%ignore eprosima::fastdds::dds::xtypes::CompleteElementDetail;
75+
%ignore eprosima::fastdds::dds::xtypes::CommonCollectionElement;
76+
%ignore eprosima::fastdds::dds::xtypes::CompleteCollectionElement;
77+
%ignore eprosima::fastdds::dds::xtypes::MinimalCollectionElement;
78+
%ignore eprosima::fastdds::dds::xtypes::CommonCollectionHeader;
79+
%ignore eprosima::fastdds::dds::xtypes::CompleteCollectionHeader;
80+
%ignore eprosima::fastdds::dds::xtypes::MinimalCollectionHeader;
81+
%ignore eprosima::fastdds::dds::xtypes::CompleteSequenceType;
82+
%ignore eprosima::fastdds::dds::xtypes::MinimalSequenceType;
83+
%ignore eprosima::fastdds::dds::xtypes::CommonArrayHeader;
84+
%ignore eprosima::fastdds::dds::xtypes::CompleteArrayHeader;
85+
%ignore eprosima::fastdds::dds::xtypes::MinimalArrayHeader;
86+
%ignore eprosima::fastdds::dds::xtypes::CompleteArrayType;
87+
%ignore eprosima::fastdds::dds::xtypes::MinimalArrayType;
88+
%ignore eprosima::fastdds::dds::xtypes::CompleteMapType;
89+
%ignore eprosima::fastdds::dds::xtypes::MinimalMapType;
90+
%ignore eprosima::fastdds::dds::xtypes::CommonEnumeratedLiteral;
91+
%ignore eprosima::fastdds::dds::xtypes::CompleteEnumeratedLiteral;
92+
%ignore eprosima::fastdds::dds::xtypes::MinimalEnumeratedLiteral;
93+
%ignore eprosima::fastdds::dds::xtypes::CommonEnumeratedHeader;
94+
%ignore eprosima::fastdds::dds::xtypes::CompleteEnumeratedHeader;
95+
%ignore eprosima::fastdds::dds::xtypes::MinimalEnumeratedHeader;
96+
%ignore eprosima::fastdds::dds::xtypes::CompleteEnumeratedType;
97+
%ignore eprosima::fastdds::dds::xtypes::MinimalEnumeratedType;
98+
%ignore eprosima::fastdds::dds::xtypes::CommonBitflag;
99+
%ignore eprosima::fastdds::dds::xtypes::CompleteBitflag;
100+
%ignore eprosima::fastdds::dds::xtypes::MinimalBitflag;
101+
%ignore eprosima::fastdds::dds::xtypes::CommonBitmaskHeader;
102+
%ignore eprosima::fastdds::dds::xtypes::CompleteBitmaskType;
103+
%ignore eprosima::fastdds::dds::xtypes::MinimalBitmaskType;
104+
%ignore eprosima::fastdds::dds::xtypes::CommonBitfield;
105+
%ignore eprosima::fastdds::dds::xtypes::CompleteBitfield;
106+
%ignore eprosima::fastdds::dds::xtypes::MinimalBitfield;
107+
%ignore eprosima::fastdds::dds::xtypes::CompleteBitsetHeader;
108+
%ignore eprosima::fastdds::dds::xtypes::MinimalBitsetHeader;
109+
%ignore eprosima::fastdds::dds::xtypes::CompleteBitsetType;
110+
%ignore eprosima::fastdds::dds::xtypes::MinimalBitsetType;
111+
%ignore eprosima::fastdds::dds::xtypes::CompleteExtendedType;
112+
%ignore eprosima::fastdds::dds::xtypes::CompleteTypeObject;
113+
%ignore eprosima::fastdds::dds::xtypes::MinimalExtendedType;
114+
%ignore eprosima::fastdds::dds::xtypes::MinimalTypeObject;
115+
%ignore eprosima::fastdds::dds::xtypes::TypeObject;
116+
%ignore eprosima::fastdds::dds::xtypes::TypeIdentifierTypeObjectPair;
117+
%ignore eprosima::fastdds::dds::xtypes::TypeIdentifierPair;
118+
%ignore eprosima::fastdds::dds::xtypes::TypeIdentfierWithSize;
119+
%ignore eprosima::fastdds::dds::xtypes::TypeIdentifierWithDependencies;
120+
%ignore eprosima::fastdds::dds::xtypes::TypeInformation::TypeInformation(TypeInformation&&);
121+
%ignore eprosima::fastdds::dds::xtypes::TypeInformation::minimal;
122+
%ignore eprosima::fastdds::dds::xtypes::TypeInformation::complete;
123+
124+
%include "fastdds/dds/xtypes/type_representation/detail/dds_xtypes_typeobject.hpp"

‎fastdds_python/src/swig/fastdds/rtps/common/InstanceHandle.i‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ long hash(const eprosima::fastrtps::rtps::InstanceHandle_t& handle)
7777

7878
// Template for std::vector<InstanceHandle_t>
7979
%template(InstanceHandleVector) std::vector<eprosima::fastrtps::rtps::InstanceHandle_t>;
80+
%typemap(doctype) std::vector<eprosima::fastrtps::rtps::InstanceHandle_t>"InstanceHandleVector";
8081

8182
%include "fastdds/rtps/common/InstanceHandle.h"
8283

‎fastdds_python/src/swig/fastrtps/types/AnnotationDescriptor.i‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)