Skip to content

Commit

Permalink
Fixed doxygen (#1197)
Browse files Browse the repository at this point in the history
* Refs #8350. Fixed double nesting on TypeObject.h

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

* Refs #8350. Fixed documentation on Subscriber.h

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>

* Refs #8350. Removed obsolete parameters from doxyfile.in

Signed-off-by: Miguel Company <MiguelCompany@eprosima.com>
  • Loading branch information
MiguelCompany committed May 6, 2020
1 parent 1b95b9b commit 461eabe
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 19 deletions.
15 changes: 0 additions & 15 deletions doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
#---------------------------------------------------------------------------
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion include/fastrtps/subscriber/Subscriber.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
6 changes: 3 additions & 3 deletions include/fastrtps/types/TypeObject.h
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ class MinimalStructMember
typedef std::vector<MinimalStructMember> MinimalStructMemberSeq;

/*struct AppliedBuiltinTypeAnnotations {
AppliedVerbatimAnnotation verbatim; // @verbatim(...) // @optional
AppliedVerbatimAnnotation verbatim; // verbatim(...) // optional
};*/
class AppliedBuiltinTypeAnnotations
{
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 461eabe

Please sign in to comment.