Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix warning generating documentation for 3.0.x [20841] #121

Merged
merged 3 commits into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions fastdds_python.repos
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ repositories:
fastdds:
type: git
url: https://github.com/eProsima/Fast-DDS.git
version: master
version: 3.0.x-devel
fastdds_python:
type: git
url: https://github.com/eProsima/Fast-DDS-python.git
version: main
fastddsgen:
type: git
url: https://github.com/eProsima/Fast-DDS-Gen.git
version: master
version: 4.0.x-devel
24 changes: 2 additions & 22 deletions fastdds_python/src/swig/fastdds.i
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ bool has_statistics();

// Macro delcarations
// Any macro used on the Fast DDS header files will give an error if it is not redefined here
#define eProsima_user_DllExport
#define FASTDDS_EXPORTED_API
#define FASTDDS_DEPRECATED_UNTIL(major, entity_name, msg)
#define FASTDDS_TODO_BEFORE(major, minor, msg)
Expand Down Expand Up @@ -312,28 +313,6 @@ namespace xtypes {
%include "fastrtps/qos/LivelinessLostStatus.i"
%include "fastrtps/qos/LivelinessChangedStatus.i"
%include "fastrtps/qos/SampleRejectedStatus.i"
%include "fastrtps/types/DynamicDataFactory.i"
%include "fastrtps/types/DynamicType.i"
%include "fastrtps/types/TypeNamesGenerator.i"
%include "fastrtps/types/AnnotationDescriptor.i"
%include "fastrtps/types/TypeDescriptor.i"
%include "fastrtps/types/DynamicDataPtr.i"
%include "fastrtps/types/DynamicTypeBuilder.i"
%include "fastrtps/types/DynamicTypeBuilderFactory.i"
%include "fastrtps/types/TypeObjectHashId.i"
%include "fastrtps/types/TypeObject.i"
%include "fastrtps/types/BuiltinAnnotationsTypeObject.i"
%include "fastrtps/types/DynamicDataHelper.i"
%include "fastrtps/types/DynamicTypeBuilderPtr.i"
%include "fastrtps/types/TypeIdentifier.i"
%include "fastrtps/types/DynamicData.i"
%include "fastrtps/types/MemberDescriptor.i"
%include "fastrtps/types/TypeIdentifierTypes.i"
%include "fastrtps/types/DynamicTypeMember.i"
%include "fastrtps/types/AnnotationParameterValue.i"
%include "fastrtps/types/TypeObjectFactory.i"
%include "fastrtps/types/DynamicTypePtr.i"
%include "fastrtps/types/DynamicPubSubType.i"
%include "fastrtps/config/doxygen_modules.i"
%include "fastrtps/log/Log.i"
%include "fastrtps/log/StdoutConsumer.i"
Expand Down Expand Up @@ -496,6 +475,7 @@ namespace xtypes {
%include "fastdds/dds/domain/qos/RequesterQos.i"
%include "fastdds/dds/domain/DomainParticipant.i"
%include "fastdds/dds/domain/DomainParticipantFactory.i"
%include "fastdds/dds/xtypes/type_representation/TypeObject.i"

// Log functionality not available in the bind
// Logs in the library is still available, only 'Log' class will not be available on Python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,4 @@
#include "fastdds/dds/common/InstanceHandle.hpp"
%}


%include "fastdds/dds/common/InstanceHandle.hpp"
Original file line number Diff line number Diff line change
Expand Up @@ -288,4 +288,8 @@
%ignore eprosima::fastdds::dds::DomainParticipant::delete_subscriber;
%ignore eprosima::fastdds::dds::DomainParticipant::create_subscriber_with_profile;

// Template for std::vector<DomainParticipant*>
%template(DomainParticipantVector) std::vector<eprosima::fastdds::dds::DomainParticipant*>;
%typemap(doctype) std::vector<eprosima::fastdds::dds::DomainParticipant*> "DomainParticipantVector";

%include "fastdds/dds/domain/DomainParticipant.hpp"
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@
#include "fastdds/dds/domain/DomainParticipantFactory.hpp"
%}

/*
%extend eprosima::fastdds::dds::DomainParticipantFactory
{
}
*/
%extend eprosima::fastdds::dds::DomainParticipantFactory
{
/**
Expand Down
3 changes: 1 addition & 2 deletions fastdds_python/src/swig/fastdds/dds/publisher/DataWriter.i
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@
const fastrtps::rtps::Time_t&);
%ignore eprosima::fastdds::dds::DataWriter::unregister_instance_w_timestamp(void*, const InstanceHandle_t&,
const fastrtps::rtps::Time_t&);
%ignore eprosima::fastdds::dds::DataWriter::get_matched_subscriptions(
std::vector<InstanceHandle_t*>&) const;

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

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

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

Expand Down
3 changes: 3 additions & 0 deletions fastdds_python/src/swig/fastdds/dds/subscriber/DataReader.i
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@

// Template for std::vector<DataReader*>
%template(DataReaderVector) std::vector<eprosima::fastdds::dds::DataReader*>;
%typemap(doctype) std::vector<eprosima::fastdds::dds::DataReader*> "DataReaderVector";

%template(SampleInfoSeq) eprosima::fastdds::dds::LoanableSequence<eprosima::fastdds::dds::SampleInfo>;
%typemap(doctype) eprosima::fastdds::dds::LoanableSequence<eprosima::fastdds::dds::SampleInfo> "SampleInfoSeq";
%extend eprosima::fastdds::dds::LoanableSequence<eprosima::fastdds::dds::SampleInfo>
{
size_t __len__() const
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
// Copyright 2024 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

%{
#include "fastdds/dds/xtypes/type_representation/detail/dds_xtypes_typeobject.hpp"
%}

%ignore eprosima::fastdds::dds::xtypes::TypeObjectHashId;
%ignore eprosima::fastdds::dds::xtypes::StringSTypeDefn;
%ignore eprosima::fastdds::dds::xtypes::StringLTypeDefn;
%ignore eprosima::fastdds::dds::xtypes::PlainCollectionHeader;
%ignore eprosima::fastdds::dds::xtypes::PlainSequenceSElemDefn;
%ignore eprosima::fastdds::dds::xtypes::PlainSequenceLElemDefn;
%ignore eprosima::fastdds::dds::xtypes::PlainArraySElemDefn;
%ignore eprosima::fastdds::dds::xtypes::PlainArrayLElemDefn;
%ignore eprosima::fastdds::dds::xtypes::PlainMapSTypeDefn;
%ignore eprosima::fastdds::dds::xtypes::PlainMapLTypeDefn;
%ignore eprosima::fastdds::dds::xtypes::StronglyConnectedComponentId;
%ignore eprosima::fastdds::dds::xtypes::ExtendedTypeDefn;
%ignore eprosima::fastdds::dds::xtypes::TypeIdentifier;
%ignore eprosima::fastdds::dds::xtypes::ExtendedAnnotationParameterValue;
%ignore eprosima::fastdds::dds::xtypes::AnnotationParameterValue;
%ignore eprosima::fastdds::dds::xtypes::AppliedAnnotationParameter;
%ignore eprosima::fastdds::dds::xtypes::AppliedAnnotation;
%ignore eprosima::fastdds::dds::xtypes::AppliedVerbatimAnnotation;
%ignore eprosima::fastdds::dds::xtypes::AppliedBuiltinMemberAnnotations;
%ignore eprosima::fastdds::dds::xtypes::CommonStructMember;
%ignore eprosima::fastdds::dds::xtypes::CompleteMemberDetail;
%ignore eprosima::fastdds::dds::xtypes::MinimalMemberDetail;
%ignore eprosima::fastdds::dds::xtypes::CompleteStructMember;
%ignore eprosima::fastdds::dds::xtypes::MinimalStructMember;
%ignore eprosima::fastdds::dds::xtypes::AppliedBuiltinTypeAnnotations;
%ignore eprosima::fastdds::dds::xtypes::MinimalTypeDetail;
%ignore eprosima::fastdds::dds::xtypes::CompleteTypeDetail;
%ignore eprosima::fastdds::dds::xtypes::CompleteStructHeader;
%ignore eprosima::fastdds::dds::xtypes::MinimalStructHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteStructType;
%ignore eprosima::fastdds::dds::xtypes::MinimalStructType;
%ignore eprosima::fastdds::dds::xtypes::CommonUnionMember;
%ignore eprosima::fastdds::dds::xtypes::CompleteUnionMember;
%ignore eprosima::fastdds::dds::xtypes::MinimalUnionMember;
%ignore eprosima::fastdds::dds::xtypes::CommonDiscriminatorMember;
%ignore eprosima::fastdds::dds::xtypes::CompleteDiscriminatorMember;
%ignore eprosima::fastdds::dds::xtypes::MinimalDiscriminatorMember;
%ignore eprosima::fastdds::dds::xtypes::CompleteUnionHeader;
%ignore eprosima::fastdds::dds::xtypes::MinimalUnionHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteUnionType;
%ignore eprosima::fastdds::dds::xtypes::MinimalUnionType;
%ignore eprosima::fastdds::dds::xtypes::CommonAnnotationParameter;
%ignore eprosima::fastdds::dds::xtypes::CompleteAnnotationParameter;
%ignore eprosima::fastdds::dds::xtypes::MinimalAnnotationParameter;
%ignore eprosima::fastdds::dds::xtypes::CompleteAnnotationHeader;
%ignore eprosima::fastdds::dds::xtypes::MinimalAnnotationHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteAnnotationType;
%ignore eprosima::fastdds::dds::xtypes::MinimalAnnotationType;
%ignore eprosima::fastdds::dds::xtypes::CommonAliasBody;
%ignore eprosima::fastdds::dds::xtypes::CompleteAliasBody;
%ignore eprosima::fastdds::dds::xtypes::MinimalAliasBody;
%ignore eprosima::fastdds::dds::xtypes::CompleteAliasHeader;
%ignore eprosima::fastdds::dds::xtypes::MinimalAliasHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteAliasType;
%ignore eprosima::fastdds::dds::xtypes::MinimalAliasType;
%ignore eprosima::fastdds::dds::xtypes::CompleteElementDetail;
%ignore eprosima::fastdds::dds::xtypes::CommonCollectionElement;
%ignore eprosima::fastdds::dds::xtypes::CompleteCollectionElement;
%ignore eprosima::fastdds::dds::xtypes::MinimalCollectionElement;
%ignore eprosima::fastdds::dds::xtypes::CommonCollectionHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteCollectionHeader;
%ignore eprosima::fastdds::dds::xtypes::MinimalCollectionHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteSequenceType;
%ignore eprosima::fastdds::dds::xtypes::MinimalSequenceType;
%ignore eprosima::fastdds::dds::xtypes::CommonArrayHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteArrayHeader;
%ignore eprosima::fastdds::dds::xtypes::MinimalArrayHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteArrayType;
%ignore eprosima::fastdds::dds::xtypes::MinimalArrayType;
%ignore eprosima::fastdds::dds::xtypes::CompleteMapType;
%ignore eprosima::fastdds::dds::xtypes::MinimalMapType;
%ignore eprosima::fastdds::dds::xtypes::CommonEnumeratedLiteral;
%ignore eprosima::fastdds::dds::xtypes::CompleteEnumeratedLiteral;
%ignore eprosima::fastdds::dds::xtypes::MinimalEnumeratedLiteral;
%ignore eprosima::fastdds::dds::xtypes::CommonEnumeratedHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteEnumeratedHeader;
%ignore eprosima::fastdds::dds::xtypes::MinimalEnumeratedHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteEnumeratedType;
%ignore eprosima::fastdds::dds::xtypes::MinimalEnumeratedType;
%ignore eprosima::fastdds::dds::xtypes::CommonBitflag;
%ignore eprosima::fastdds::dds::xtypes::CompleteBitflag;
%ignore eprosima::fastdds::dds::xtypes::MinimalBitflag;
%ignore eprosima::fastdds::dds::xtypes::CommonBitmaskHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteBitmaskType;
%ignore eprosima::fastdds::dds::xtypes::MinimalBitmaskType;
%ignore eprosima::fastdds::dds::xtypes::CommonBitfield;
%ignore eprosima::fastdds::dds::xtypes::CompleteBitfield;
%ignore eprosima::fastdds::dds::xtypes::MinimalBitfield;
%ignore eprosima::fastdds::dds::xtypes::CompleteBitsetHeader;
%ignore eprosima::fastdds::dds::xtypes::MinimalBitsetHeader;
%ignore eprosima::fastdds::dds::xtypes::CompleteBitsetType;
%ignore eprosima::fastdds::dds::xtypes::MinimalBitsetType;
%ignore eprosima::fastdds::dds::xtypes::CompleteExtendedType;
%ignore eprosima::fastdds::dds::xtypes::CompleteTypeObject;
%ignore eprosima::fastdds::dds::xtypes::MinimalExtendedType;
%ignore eprosima::fastdds::dds::xtypes::MinimalTypeObject;
%ignore eprosima::fastdds::dds::xtypes::TypeObject;
%ignore eprosima::fastdds::dds::xtypes::TypeIdentifierTypeObjectPair;
%ignore eprosima::fastdds::dds::xtypes::TypeIdentifierPair;
%ignore eprosima::fastdds::dds::xtypes::TypeIdentfierWithSize;
%ignore eprosima::fastdds::dds::xtypes::TypeIdentifierWithDependencies;
%ignore eprosima::fastdds::dds::xtypes::TypeInformation::TypeInformation(TypeInformation&&);
%ignore eprosima::fastdds::dds::xtypes::TypeInformation::minimal;
%ignore eprosima::fastdds::dds::xtypes::TypeInformation::complete;

%include "fastdds/dds/xtypes/type_representation/detail/dds_xtypes_typeobject.hpp"
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ long hash(const eprosima::fastrtps::rtps::InstanceHandle_t& handle)

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

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

Expand Down
19 changes: 0 additions & 19 deletions fastdds_python/src/swig/fastrtps/types/AnnotationDescriptor.i

This file was deleted.

19 changes: 0 additions & 19 deletions fastdds_python/src/swig/fastrtps/types/AnnotationParameterValue.i

This file was deleted.

This file was deleted.

19 changes: 0 additions & 19 deletions fastdds_python/src/swig/fastrtps/types/DynamicData.i

This file was deleted.

19 changes: 0 additions & 19 deletions fastdds_python/src/swig/fastrtps/types/DynamicDataFactory.i

This file was deleted.

19 changes: 0 additions & 19 deletions fastdds_python/src/swig/fastrtps/types/DynamicDataHelper.i

This file was deleted.

19 changes: 0 additions & 19 deletions fastdds_python/src/swig/fastrtps/types/DynamicDataPtr.i

This file was deleted.

Loading