Skip to content

Commit 4f6fe74

Browse files
nim65snim65s
committed
format
1 parent def3693 commit 4f6fe74

File tree

16 files changed

+172
-134
lines changed

16 files changed

+172
-134
lines changed

‎doc/footer.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,3 @@
88
</center>
99
</body>
1010
</head>
11-

‎doc/header.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,3 @@
44
<LINK HREF="package.css" REL="stylesheet" TYPE="text/css">
55
</HEAD>
66
<BODY>
7-

‎doc/package.css‎

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ a:link {
4545
color:#0066CC
4646
}
4747

48-
a:hover, a:active {
49-
text-decoration: underline;
48+
a:hover, a:active {
49+
text-decoration: underline;
5050
color: #3C9A35;
5151
}
5252

@@ -57,7 +57,7 @@ a:visited {
5757
}
5858

5959
DIV.memitem
60-
{
60+
{
6161
spacing: 10px;
6262
width:100%;
6363
background:#FFFFFF;
@@ -70,7 +70,7 @@ DIV.memitem
7070
}
7171

7272
DIV.memproto
73-
{
73+
{
7474
width:100%;
7575
background:#F0F0F0;
7676
font-size:100%;
@@ -82,7 +82,7 @@ DIV.memproto
8282
}
8383

8484
DIV.memdoc
85-
{
85+
{
8686
padding: 10px;
8787
width:100%;
8888
font-size:100%;
@@ -189,7 +189,7 @@ DIV.nav
189189
}
190190

191191
DIV.groupHeader
192-
{
192+
{
193193
padding-top: 30px;
194194
padding-bottom: 20px;
195195
background : none;
@@ -214,23 +214,23 @@ DIV.fragment
214214
-moz-border-radius: 8px 8px 8px 8px;
215215
}
216216

217-
.directory p
218-
{
219-
margin: 0px;
220-
white-space: nowrap;
217+
.directory p
218+
{
219+
margin: 0px;
220+
white-space: nowrap;
221221
font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif;
222222
font-size: 10pt;
223223
font-weight: normal;
224224
}
225225

226226

227-
.directory h3
228-
{
227+
.directory h3
228+
{
229229
font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif;
230-
margin: 0px;
231-
margin-top: 1em;
230+
margin: 0px;
231+
margin-top: 1em;
232232
padding-bottom: 20px;
233-
font-size: 12pt;
233+
font-size: 12pt;
234234
font-variant: small-caps;
235235
text-align: center;
236236
}
@@ -240,4 +240,3 @@ DIV.fragment
240240
text-decoration: none;
241241
color:#0066CC
242242
}
243-

‎doc/package.dox.cmake‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ ABBREVIATE_BRIEF = "The $name class" \
2323
ALWAYS_DETAILED_SEC = YES
2424
INLINE_INHERITED_MEMB = NO
2525
FULL_PATH_NAMES = NO
26-
STRIP_FROM_PATH =
27-
STRIP_FROM_INC_PATH =
26+
STRIP_FROM_PATH =
27+
STRIP_FROM_INC_PATH =
2828
SHORT_NAMES = NO
2929
JAVADOC_AUTOBRIEF = YES
3030
MULTILINE_CPP_IS_BRIEF = NO
@@ -49,7 +49,7 @@ SORT_MEMBER_DOCS = YES
4949
SORT_BRIEF_DOCS = NO
5050
SORT_BY_SCOPE_NAME = NO
5151
MAX_INITIALIZER_LINES = 30
52-
FILE_VERSION_FILTER =
52+
FILE_VERSION_FILTER =
5353
#---------------------------------------------------------------------------
5454
# configuration options related to warning and progress messages
5555
#---------------------------------------------------------------------------
@@ -59,18 +59,18 @@ WARN_IF_UNDOCUMENTED = YES
5959
WARN_IF_DOC_ERROR = YES
6060
WARN_NO_PARAMDOC = NO
6161
WARN_FORMAT = "$file:$line: $text"
62-
WARN_LOGFILE =
62+
WARN_LOGFILE =
6363
#---------------------------------------------------------------------------
6464
# configuration options related to the input files
6565
#---------------------------------------------------------------------------
6666
RECURSIVE = YES
67-
EXCLUDE =
67+
EXCLUDE =
6868
EXCLUDE_SYMLINKS = NO
69-
EXAMPLE_PATH =
69+
EXAMPLE_PATH =
7070
EXAMPLE_PATTERNS = *
7171
EXAMPLE_RECURSIVE = NO
72-
INPUT_FILTER =
73-
FILTER_PATTERNS =
72+
INPUT_FILTER =
73+
FILTER_PATTERNS =
7474
FILTER_SOURCE_FILES = NO
7575
#---------------------------------------------------------------------------
7676
# configuration options related to source browsing
@@ -80,16 +80,16 @@ FILTER_SOURCE_FILES = NO
8080
#---------------------------------------------------------------------------
8181
ALPHABETICAL_INDEX = NO
8282
COLS_IN_ALPHA_INDEX = 5
83-
IGNORE_PREFIX =
83+
IGNORE_PREFIX =
8484
#---------------------------------------------------------------------------
8585
# configuration options related to the HTML output
8686
#---------------------------------------------------------------------------
8787
GENERATE_HTML = YES
8888
HTML_FILE_EXTENSION = .html
8989
HTML_ALIGN_MEMBERS = YES
9090
GENERATE_HTMLHELP = NO
91-
CHM_FILE =
92-
HHC_LOCATION =
91+
CHM_FILE =
92+
HHC_LOCATION =
9393
GENERATE_CHI = NO
9494
BINARY_TOC = NO
9595
TOC_EXPAND = YES
@@ -105,8 +105,8 @@ LATEX_CMD_NAME = latex
105105
MAKEINDEX_CMD_NAME = makeindex
106106
COMPACT_LATEX = NO
107107
PAPER_TYPE = a4wide
108-
EXTRA_PACKAGES =
109-
LATEX_HEADER =
108+
EXTRA_PACKAGES =
109+
LATEX_HEADER =
110110
PDF_HYPERLINKS = NO
111111
USE_PDFLATEX = NO
112112
LATEX_BATCHMODE = NO
@@ -118,8 +118,8 @@ FORMULA_FONTSIZE = 16
118118
RTF_OUTPUT = rtf
119119
COMPACT_RTF = NO
120120
RTF_HYPERLINKS = NO
121-
RTF_STYLESHEET_FILE =
122-
RTF_EXTENSIONS_FILE =
121+
RTF_STYLESHEET_FILE =
122+
RTF_EXTENSIONS_FILE =
123123
#---------------------------------------------------------------------------
124124
# configuration options related to the man page output
125125
#---------------------------------------------------------------------------
@@ -130,8 +130,8 @@ MAN_LINKS = NO
130130
# configuration options related to the XML output
131131
#---------------------------------------------------------------------------
132132
XML_OUTPUT = xml
133-
XML_SCHEMA =
134-
XML_DTD =
133+
XML_SCHEMA =
134+
XML_DTD =
135135
XML_PROGRAMLISTING = YES
136136
#---------------------------------------------------------------------------
137137
# configuration options for the AutoGen Definitions output
@@ -142,20 +142,20 @@ GENERATE_AUTOGEN_DEF = NO
142142
#---------------------------------------------------------------------------
143143
PERLMOD_LATEX = NO
144144
PERLMOD_PRETTY = YES
145-
PERLMOD_MAKEVAR_PREFIX =
145+
PERLMOD_MAKEVAR_PREFIX =
146146
#---------------------------------------------------------------------------
147-
# Configuration options related to the preprocessor
147+
# Configuration options related to the preprocessor
148148
#---------------------------------------------------------------------------
149149
ENABLE_PREPROCESSING = YES
150150
MACRO_EXPANSION = YES
151151
EXPAND_ONLY_PREDEF = YES
152152
SEARCH_INCLUDES = YES
153-
INCLUDE_PATH =
154-
INCLUDE_FILE_PATTERNS =
155-
EXPAND_AS_DEFINED =
153+
INCLUDE_PATH =
154+
INCLUDE_FILE_PATTERNS =
155+
EXPAND_AS_DEFINED =
156156
SKIP_FUNCTION_MACROS = YES
157157
#---------------------------------------------------------------------------
158-
# Configuration::additions related to external references
158+
# Configuration::additions related to external references
159159
#---------------------------------------------------------------------------
160160
TAGFILES = \
161161
${DYNAMIC_GRAPH_PYTHON_DOCDIR}/html/dynamic-graph-python.doxytag=${DYNAMIC_GRAPH_PYTHON_DOCDIR}/html \
@@ -165,10 +165,10 @@ ALLEXTERNALS = NO
165165
EXTERNAL_GROUPS = YES
166166
PERL_PATH = /usr/bin/perl
167167
#---------------------------------------------------------------------------
168-
# Configuration options related to the dot tool
168+
# Configuration options related to the dot tool
169169
#---------------------------------------------------------------------------
170170
#---------------------------------------------------------------------------
171-
# Configuration::additions related to the search engine
171+
# Configuration::additions related to the search engine
172172
#---------------------------------------------------------------------------
173173
SEARCHENGINE = NO
174174

@@ -197,7 +197,7 @@ GENERATE_TODOLIST = YES
197197
GENERATE_TESTLIST = NO
198198
GENERATE_BUGLIST = NO
199199
GENERATE_DEPRECATEDLIST= YES
200-
ENABLED_SECTIONS =
200+
ENABLED_SECTIONS =
201201
SHOW_USED_FILES = NO
202202
SHOW_DIRECTORIES = NO
203203
#---------------------------------------------------------------------------
@@ -207,7 +207,7 @@ SHOW_DIRECTORIES = NO
207207
# configuration options related to the input files
208208
#---------------------------------------------------------------------------
209209
FILE_PATTERNS = *.hh *.idl
210-
EXCLUDE_PATTERNS =
210+
EXCLUDE_PATTERNS =
211211
INPUT = ${${PROJECT_NAME}_SOURCE_DIR}/include \
212212
${CMAKE_CURRENT_SOURCE_DIR}/additionalDoc
213213

@@ -261,13 +261,13 @@ GENERATE_AUTOGEN_DEF = NO
261261
#---------------------------------------------------------------------------
262262
GENERATE_PERLMOD = NO
263263
#---------------------------------------------------------------------------
264-
# Configuration options related to the preprocessor
264+
# Configuration options related to the preprocessor
265265
#---------------------------------------------------------------------------
266266
#---------------------------------------------------------------------------
267-
# Configuration::additions related to external references
267+
# Configuration::additions related to external references
268268
#---------------------------------------------------------------------------
269269
#---------------------------------------------------------------------------
270-
# Configuration options related to the dot tool
270+
# Configuration options related to the dot tool
271271
#---------------------------------------------------------------------------
272272
CLASS_DIAGRAMS = YES
273273
HIDE_UNDOC_RELATIONS = YES
@@ -283,8 +283,8 @@ CALL_GRAPH = NO
283283
GRAPHICAL_HIERARCHY = YES
284284
DIRECTORY_GRAPH = YES
285285
DOT_IMAGE_FORMAT = png
286-
DOT_PATH =
287-
DOTFILE_DIRS =
286+
DOT_PATH =
287+
DOTFILE_DIRS =
288288
MAX_DOT_GRAPH_DEPTH = 1000
289289
DOT_TRANSPARENT = NO
290290
DOT_MULTI_TARGETS = YES

‎include/dynamic-graph/tutorial/doc-cxx.hh‎

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ As an example, we review below class dynamicgraph::tutorial::InvertedPendulum.
1111
1212
\section dg_tutorial_inverted_pendulum_cxx_interface Interface
1313
14-
The interface is defined in file <c>include/dynamic-graph/tutorial/inverted-pendulum.hh</c>.
14+
The interface is defined in file
15+
<c>include/dynamic-graph/tutorial/inverted-pendulum.hh</c>.
1516
1617
First, we include
1718
\li the header defining Entity class and
@@ -20,8 +21,8 @@ First, we include
2021
2122
\code
2223
#include <dynamic-graph/entity.h>
23-
#include <dynamic-graph/signal-ptr.h>
2424
#include <dynamic-graph/linear-algebra.h>
25+
#include <dynamic-graph/signal-ptr.h>
2526
\endcode
2627
2728
Then in namespace <c>dynamicgraph::tutorial</c> we define class InvertedPendulum
@@ -108,14 +109,16 @@ First, we include headers defining
108109
\subsection dg_tutorial_inverted_pendulum_cxx_implementation_headers Headers
109110
110111
\code
111-
#include <dynamic-graph/factory.h>
112-
#include <dynamic-graph/command-setter.h>
113112
#include <dynamic-graph/command-getter.h>
114-
#include "dynamic-graph/tutorial/inverted-pendulum.hh"
113+
#include <dynamic-graph/command-setter.h>
114+
#include <dynamic-graph/factory.h>
115+
115116
#include "command-increment.hh"
117+
#include "dynamic-graph/tutorial/inverted-pendulum.hh"
116118
\endcode
117119
118-
\subsection dg_tutorial_inverted_pendulum_cxx_implementation_entity_registration Entity registration
120+
\subsection dg_tutorial_inverted_pendulum_cxx_implementation_entity_registration
121+
Entity registration
119122
120123
The second step consists in
121124
\li registering our new class into the entity factory and
@@ -130,7 +133,8 @@ using a macro defined in <c>dynamic-graph/factory.h</c>:
130133
\li the name of the type of the corresponding python class. It is highly
131134
recommended to use the same name for both.
132135
133-
\subsection dg_tutorial_inverted_pendulum_cxx_implementation_constructor Constructor
136+
\subsection dg_tutorial_inverted_pendulum_cxx_implementation_constructor
137+
Constructor
134138
135139
Then we define the class constructor
136140
\li passing the instance name to Entity class constructor,
@@ -160,10 +164,9 @@ We set input and output signal as constant with a given value
160164
\endcode
161165
162166
The following lines of code define and register commands into the entity.
163-
A \ref dynamicgraph::command::Command "command" is created by calling a constructor with
164-
\li a string: the name of the command,
165-
\li a pointer to a newly created command and
166-
\li a string documenting the command:
167+
A \ref dynamicgraph::command::Command "command" is created by calling a
168+
constructor with \li a string: the name of the command, \li a pointer to a newly
169+
created command and \li a string documenting the command:
167170
168171
\code
169172
std::string docstring;
@@ -180,10 +183,12 @@ A \ref dynamicgraph::command::Command "command" is created by calling a construc
180183
\endcode
181184
182185
In this example, command::Increment is a command specific to our class
183-
InvertedPendulum. This new command is explained in page \ref dg_tutorial_inverted_pendulum_command.
186+
InvertedPendulum. This new command is explained in page \ref
187+
dg_tutorial_inverted_pendulum_command.
184188
185-
Setter and getter commands are available through classes templated by the type of entity using the command and the type
186-
of the parameter. Be aware that only a prespecified set of types are supported for commands, see class
189+
Setter and getter commands are available through classes templated by the type
190+
of entity using the command and the type of the parameter. Be aware that only a
191+
prespecified set of types are supported for commands, see class
187192
dynamicgraph::command::Value. \code docstring =
188193
"\n"
189194
" Set cart mass\n"
@@ -203,18 +208,22 @@ dynamicgraph::command::Value. \code docstring =
203208
204209
\note
205210
It is important to notice that
206-
\li commands passed to method Entity::addCommand will be destroyed automatically by Entity class destructor. The user
207-
should therefore not destroy them, \li commands should be defined and registered in the class constructor. Commands
211+
\li commands passed to method Entity::addCommand will be destroyed automatically
212+
by Entity class destructor. The user should therefore not destroy them, \li
213+
commands should be defined and registered in the class constructor. Commands
208214
defined later on will not be reachable by python bindings.
209215
210-
\subsection dg_tutorial_inverted_pendulum_cxx_implementation_newtypes Registering new types: advanced feature
216+
\subsection dg_tutorial_inverted_pendulum_cxx_implementation_newtypes
217+
Registering new types: advanced feature
211218
212-
Signals are templated by the type of data they convey. In this example, we hae defined our own class of vectors
213-
InvertedPendulum::Vector. In order to be able to create signals with this type, we need to register the new type: \code
219+
Signals are templated by the type of data they convey. In this example, we hae
220+
defined our own class of vectors InvertedPendulum::Vector. In order to be able
221+
to create signals with this type, we need to register the new type: \code
214222
dynamicgraph::DefaultCastRegisterer<InvertedPendulum::Vector> IPVectorCast;
215223
\endcode
216224
217225
\note
218-
The new type should implement operator<< and operator>> in order to store variables in streams.
226+
The new type should implement operator<< and operator>> in order to store
227+
variables in streams.
219228
220229
*/

0 commit comments

Comments
 (0)