Skip to content

Commit

Permalink
[Doc] Update doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmirabel committed Dec 21, 2018
1 parent e3abe60 commit 533b353
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 33 deletions.
6 changes: 1 addition & 5 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ SET(CUSTOM_HEADER_DIR hpp/corbaserver/manipulation)

SETUP_HPP_PROJECT ()

CONFIG_FILES (include/hpp/corbaserver/manipulation/doc.hh)
CONFIG_FILES (doc/main.hh)

SET(${PROJECT_NAME}_HEADERS
include/hpp/corbaserver/manipulation/client.hh
Expand All @@ -44,7 +44,6 @@ IF (NOT CLIENT_ONLY)
SET(${PROJECT_NAME}_HEADERS
include/hpp/corbaserver/manipulation/server.hh
include/hpp/corbaserver/manipulation/fwd.hh
${CMAKE_BINARY_DIR}/include/hpp/corbaserver/manipulation/doc.hh
${${PROJECT_NAME}_HEADERS}
)
ENDIF (NOT CLIENT_ONLY)
Expand All @@ -55,9 +54,6 @@ IF (HPP_DEBUG)
SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DHPP_DEBUG")
ENDIF()

# Ask Doxygen to create a tree view in html documentation
SET(DOXYGEN_TREEVIEW "NO" CACHE STRING "Set to YES to generate a tree view in the html documentation")

SET(HPP_MANIPULATION_HAS_WHOLEBODY_STEP TRUE
CACHE BOOL "Compile with dependency to hpp-wholebody-step-corba")

Expand Down
4 changes: 1 addition & 3 deletions doc/Doxyfile.extra.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
INPUT = @CMAKE_SOURCE_DIR@/include \
@CMAKE_BINARY_DIR@/include \
@CMAKE_BINARY_DIR@/doc \
@CMAKE_SOURCE_DIR@/idl \
@CMAKE_SOURCE_DIR@/src/hpp/corbaserver/manipulation/problem_solver.py \
@CMAKE_SOURCE_DIR@/src/hpp/corbaserver/manipulation/constraint_graph.py \
Expand All @@ -10,5 +10,3 @@ INPUT = @CMAKE_SOURCE_DIR@/include \
FILE_PATTERNS = *.cc *.cpp \
*.hh *.hxx \
*.idl *.py

GENERATE_TREEVIEW = @DOXYGEN_TREEVIEW@
30 changes: 5 additions & 25 deletions ...de/hpp/corbaserver/manipulation/doc.hh.in → doc/main.hh.in
Original file line number Diff line number Diff line change
@@ -1,25 +1,7 @@
// Copyright (C) 2014 CNRS-LAAS
// Author: Florent Lamiraux.
//
// This file is part of the hpp-manipulation-corba.
//
// hpp-manipulation-corba is free software: you can redistribute
// it and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation, either
// version 3 of the License, or (at your option) any later version.
//
// hpp-manipulation-corba is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with hpp-manipulation-corba. If not, see
// <http://www.gnu.org/licenses/>.

/// \mainpage
/// \mainpage Package documentation
/// \anchor hpp_manipulation_corba_documentation
///
/// \section hpp_manipulation_corba_intro Introduction
/// \par Introduction
///
/// This package implements a Corba server running hpp-manipulation
/// package functions and the corresponding client.
Expand All @@ -45,8 +27,7 @@
///
/// See these package documentations for details.
///
/// \section hpp_manipulation_corba_howto_communicate \
/// How to communicate with the CORBA server
/// \par How to communicate with the CORBA server
///
/// The easiest way to launch \c hpp-manipulation-server executable is to
/// open a python terminal and type:
Expand Down Expand Up @@ -77,8 +58,7 @@
/// \li manipulation.constraint_graph_factory.ConstraintGraphFactory to
/// create a graph of constraints
///
/// \section hpp_manipulation_corba_how_to_embed \
/// How to embed a server in an application
/// \par How to embed a server in an application
///
/// Embedding the corba server into an application can be done by linking the
/// application with \c libhpp-manipulation-corba.so in a similar way as
Expand Down

0 comments on commit 533b353

Please sign in to comment.