Skip to content

Commit 8970e5d

Browse files
author
Neil T. Dantam
committed
Documentation update
* include ach/experimental.h in doxygen output * update copyright info in doxygen * new docbook revision
1 parent 454948d commit 8970e5d

File tree

3 files changed

+48
-25
lines changed

3 files changed

+48
-25
lines changed

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@ WARN_LOGFILE =
655655
# directories like "/usr/src/myproject". Separate the files or directories
656656
# with spaces.
657657

658-
INPUT = include/ach.h include/ach/generic.h
658+
INPUT = include/ach.h include/ach/generic.h include/ach/experimental.h
659659

660660
# This tag can be used to specify the character encoding of the source files
661661
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

doc/ach-manual.xml

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,34 @@
1111
<othername role='mi'>T</othername>
1212
<affiliation>
1313
<!-- Valid email...spamblock/scramble if so desired -->
14-
<address><email>ntd at gatech dot edu</email></address>
14+
<address><email>ntd at rice dot edu</email></address>
1515
</affiliation>
1616
</author>
1717

1818
<!-- All dates specified in ISO "YYYY-MM-DD" format -->
19-
<pubdate>2013-01-21</pubdate>
19+
<pubdate>2015-02-02</pubdate>
2020

2121
<copyright>
22-
<year>2012-2013</year>
22+
<year>2012-2014</year>
2323
<holder>Georgia Tech Research Corporation</holder>
2424
</copyright>
2525

26+
<copyright>
27+
<year>2015</year>
28+
<holder>Rice University</holder>
29+
</copyright>
30+
2631
<!-- Most recent revision goes at the top; list in descending order -->
2732
<revhistory>
33+
<revision>
34+
<revnumber>2.0.0</revnumber>
35+
<date>2015-02-02</date>
36+
<authorinitials>NTD</authorinitials>
37+
<revremark>
38+
New Release with kernel channels and improved mDNS
39+
integration
40+
</revremark>
41+
</revision>
2842
<revision>
2943
<revnumber>1.2.1</revnumber>
3044
<date>2014-04-07</date>

include/ach.h

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -82,37 +82,46 @@
8282
* client application.
8383
*
8484
* \author Neil T. Dantam
85+
* \author Kim Bøndergaard
86+
* \author Matt Zucker
87+
* \author Jon Scholz
88+
* \author Saul Reynolds-Haertle
8589
* \author Developed at the Georgia Tech Humanoid Robotics Lab
8690
* \author Under Direction of Professor Mike Stilman
8791
*
88-
* Copyright (c) 2008-2013, Georgia Tech Research Corporation.
89-
* All rights reserved.
90-
*
91-
* Redistribution and use in source and binary forms, with or
92-
* without modification, are permitted provided that the following
93-
* conditions are met:
94-
*
92+
* \copyright Copyright (c) 2008-2014, Georgia Tech Research Corporation.
93+
* \copyright Copyright (c) 2013-2014, Prevas A/S.
94+
* \copyright Copyright (c) 2015, Rice University.
95+
* \copyright All rights reserved.
96+
* \copyright
97+
* Redistribution and use in source and binary forms, with or
98+
* without modification, are permitted provided that the following
99+
* conditions are met:
95100
* - Redistributions of source code must retain the above copyright
96101
* notice, this list of conditions and the following disclaimer.
97-
*
98102
* - Redistributions in binary form must reproduce the above
99103
* copyright notice, this list of conditions and the following
100104
* disclaimer in the documentation and/or other materials provided
101105
* with the distribution.
106+
* - Neither the name of the copyright holder the names of its
107+
* contributors may be used to endorse or promote products derived
108+
* from this software without specific prior written permission.
109+
*
110+
* \copyright
111+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
112+
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
113+
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
114+
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
115+
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
116+
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
117+
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
118+
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
119+
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
120+
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
121+
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
122+
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
123+
* POSSIBILITY OF SUCH DAMAGE.
102124
*
103-
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
104-
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
105-
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
106-
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
107-
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
108-
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
109-
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
110-
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
111-
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
112-
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
113-
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
114-
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
115-
* POSSIBILITY OF SUCH DAMAGE.
116125
*
117126
*/
118127

0 commit comments

Comments
 (0)