Added cmake to build documentation, and updated documentation in Igni…

…tion.hh

CMakeLists.txt

@@ -70,3 +70,13 @@ add_subdirectory(conf)
 # Create package information
 #============================================================================
 ign_create_packages()
+
+#============================================================================
+# Configure documentation
+#============================================================================
+configure_file(${CMAKE_SOURCE_DIR}/api.md.in ${CMAKE_BINARY_DIR}/api.md)
+configure_file(${CMAKE_SOURCE_DIR}/tutorials.md.in ${CMAKE_BINARY_DIR}/tutorials.md)
+
+ign_create_docs(
+  API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
+  TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md")

api.md.in

@@ -0,0 +1,10 @@
+## Ignition @IGN_DESIGNATION_CAP@
+
+Ignition @IGN_DESIGNATION_CAP@ is a component in Ignition Robotics, a set of libraries
+designed to rapidly develop robot and simulation applications. 
+
+## License
+
+The code associated with this documentation is licensed under an [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+
+This documentation is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).

include/ignition/fuel_tools/Interface.hh

@@ -30,8 +30,8 @@ namespace ignition
     IGNITION_FUEL_TOOLS_VISIBLE std::string fetchResource(
         const std::string &_uri);
 
-    /// \brief Download the specified resource into the default configuration of
-    /// fuel tools. This will place the asset in ~/.ignition/fuel.
+    /// \brief Download the specified resource using the ClientConfig
+    /// contained in the FuelClient parameter.
     /// \param[in] _uri URI to the asset.
     /// \param[in] _client Custom FuelClient configuration.
     /// \return Path to the downloaded asset. Empty on error.

tutorials.md.in

@@ -0,0 +1,16 @@
+\page tutorials Tutorials
+
+Welcome to the Ignition @IGN_DESIGNATION_CAP@ tutorials. These tutorials
+will guide you through the process of understanding the capabilities of the
+Ignition @IGN_DESIGNATION_CAP@ library and how to use the library effectively.
+
+
+**The tutorials**
+
+No tutorials yet.
+
+## License
+
+The code associated with this documentation is licensed under an [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+
+This documentation is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).