From 533b353a5846f67f1c5bfcb766b64743b569632a Mon Sep 17 00:00:00 2001 From: Joseph Mirabel Date: Fri, 21 Dec 2018 15:28:18 +0100 Subject: [PATCH] [Doc] Update doc. --- CMakeLists.txt | 6 +--- doc/Doxyfile.extra.in | 4 +-- .../manipulation/doc.hh.in => doc/main.hh.in | 30 ++++--------------- 3 files changed, 7 insertions(+), 33 deletions(-) rename include/hpp/corbaserver/manipulation/doc.hh.in => doc/main.hh.in (71%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 11b20b7..41f3885 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -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 @@ -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) @@ -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") diff --git a/doc/Doxyfile.extra.in b/doc/Doxyfile.extra.in index 587d79f..6e22dea 100644 --- a/doc/Doxyfile.extra.in +++ b/doc/Doxyfile.extra.in @@ -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 \ @@ -10,5 +10,3 @@ INPUT = @CMAKE_SOURCE_DIR@/include \ FILE_PATTERNS = *.cc *.cpp \ *.hh *.hxx \ *.idl *.py - -GENERATE_TREEVIEW = @DOXYGEN_TREEVIEW@ diff --git a/include/hpp/corbaserver/manipulation/doc.hh.in b/doc/main.hh.in similarity index 71% rename from include/hpp/corbaserver/manipulation/doc.hh.in rename to doc/main.hh.in index a57f93a..db5d281 100644 --- a/include/hpp/corbaserver/manipulation/doc.hh.in +++ b/doc/main.hh.in @@ -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 -// . - -/// \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. @@ -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: @@ -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