Update documentation

gazebosim · Mar 13, 2019 · 4a94b3c · 4a94b3c
1 parent 490b493
commit 4a94b3c
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 10 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -79,4 +79,7 @@ configure_file(${CMAKE_SOURCE_DIR}/tutorials.md.in ${CMAKE_BINARY_DIR}/tutorials
 
 ign_create_docs(
   API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
-  TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md")
+  TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md"
+  TAGFILES
+   "${IGNITION-COMMON_DOXYGEN_TAGFILE} = ${IGNITION-COMMON_API_URL}"
+  )
diff --git a/include/ignition/fuel_tools/FuelClient.hh b/include/ignition/fuel_tools/FuelClient.hh
@@ -162,7 +162,7 @@ namespace ignition
       /// E.g.: https://fuel.ignitionrobotics.org/1.0/caguero/models/Beer
       /// \param[out] _path Path where the model was downloaded.
       /// \return Result of the download operation.
-      public: Result DownloadModel(const common::URI &_modelUrl,
+      public: Result DownloadModel(const ignition::common::URI &_modelUrl,
                                    std::string &_path);
 
       /// \brief Download a world from ignition fuel. This will override an

diff --git a/tutorials.md.in b/tutorials.md.in
@@ -7,7 +7,10 @@ Ignition @IGN_DESIGNATION_CAP@ library and how to use the library effectively.
 
 **The tutorials**
 
-No tutorials yet.
+1. \subpage install "Installation"
+2. \subpage configuration "Configuration"
+3. \subpage cmdline "Command Line Tools"
+4. \subpage cppapi "C++ API"
 
 ## License
 

diff --git a/tutorials/01_installation.md b/tutorials/01_installation.md
@@ -1,4 +1,8 @@
-# Installation
+\page install Installation
+
+Next Tutorial: \ref configuration
+
+## Overview
 
 Instructions to install Ignition Fuel Tools on all the platforms
 supported: major Linux distributions, Mac OS X and Windows.

diff --git a/tutorials/02_configuration.md b/tutorials/02_configuration.md
@@ -1,5 +1,8 @@
-Configuration
-=============
+\page configuration Configuration
+
+Next Tutorial: \ref cmdline
+
+## Overview
 
 Some aspects of Ignition Fuel Tools can be configured according to the needs of
 the library users. This configuration can be done via a YAML configuration file

diff --git a/tutorials/03_command_line.md b/tutorials/03_command_line.md
@@ -1,5 +1,8 @@
-Command line tools
-======
+\page cmdline Command Line Tools
+
+Next Tutorial: \ref cppapi
+
+## Overview
 
 The `ign fuel` command line tool provides a convenient way to handle Ignition
 Fuel resources from a terminal.

diff --git a/tutorials/04_cpp_api.md b/tutorials/04_cpp_api.md
@@ -1,5 +1,6 @@
-C++ API
-======
+\page cppapi C++ API
+
+## Overview 
 
 Ignition Fuel Tools lets you perform a set of operations over the resources
 hosted in any Ignition Fuel server. These operations allow you to list all