From 461eabe2a34c96301402368741b4d3480341fdfa Mon Sep 17 00:00:00 2001 From: Miguel Company Date: Wed, 6 May 2020 07:53:44 +0200 Subject: [PATCH] Fixed doxygen (#1197) * Refs #8350. Fixed double nesting on TypeObject.h Signed-off-by: Miguel Company * Refs #8350. Fixed documentation on Subscriber.h Signed-off-by: Miguel Company * Refs #8350. Removed obsolete parameters from doxyfile.in Signed-off-by: Miguel Company --- doxyfile.in | 15 --------------- include/fastrtps/subscriber/Subscriber.h | 2 +- include/fastrtps/types/TypeObject.h | 6 +++--- 3 files changed, 4 insertions(+), 19 deletions(-) diff --git a/doxyfile.in b/doxyfile.in index ad4bf1e35e3..74c187c2803 100644 --- a/doxyfile.in +++ b/doxyfile.in @@ -2041,12 +2041,6 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- @@ -2060,15 +2054,6 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = NO -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. diff --git a/include/fastrtps/subscriber/Subscriber.h b/include/fastrtps/subscriber/Subscriber.h index 619fa9b160d..245b5aa2300 100644 --- a/include/fastrtps/subscriber/Subscriber.h +++ b/include/fastrtps/subscriber/Subscriber.h @@ -156,7 +156,7 @@ class RTPS_DllAPI Subscriber /** * @brief Get the requested deadline missed status - * @return The deadline missed status + * @param status The deadline missed status */ void get_requested_deadline_missed_status( RequestedDeadlineMissedStatus& status); diff --git a/include/fastrtps/types/TypeObject.h b/include/fastrtps/types/TypeObject.h index 6b33cc99388..9fdbd23374d 100644 --- a/include/fastrtps/types/TypeObject.h +++ b/include/fastrtps/types/TypeObject.h @@ -325,7 +325,7 @@ class MinimalStructMember typedef std::vector MinimalStructMemberSeq; /*struct AppliedBuiltinTypeAnnotations { - AppliedVerbatimAnnotation verbatim; // @verbatim(...) // @optional + AppliedVerbatimAnnotation verbatim; // verbatim(...) // optional };*/ class AppliedBuiltinTypeAnnotations { @@ -407,8 +407,8 @@ class MinimalTypeDetail }; /*struct CompleteTypeDetail final{ - AppliedBuiltinTypeAnnotations ann_builtin; // @optional - AppliedAnnotationSeq ann_custom; // @optional + AppliedBuiltinTypeAnnotations ann_builtin; // optional + AppliedAnnotationSeq ann_custom; // optional QualifiedTypeName type_name; };*/ class CompleteTypeDetail