Merge branch 'ign-cmake2' into visibility_macro_hyphen

CMakeLists.txt

@@ -182,3 +182,24 @@ if (BUILD_TESTING AND BUILDSYSTEM_TESTING)
 
   add_subdirectory(examples)
 endif()
+
+# Codecheck
+set(CPPCHECK_DIRS
+  ${CMAKE_SOURCE_DIR}/examples
+)
+set(CPPCHECK_INCLUDE_DIRS
+  ${CMAKE_SOURCE_DIR}/include
+  ${CMAKE_SOURCE_DIR}/examples
+)
+set(IGNITION_CMAKE_CODECHECK_DIR "${CMAKE_CURRENT_SOURCE_DIR}/codecheck")
+include(IgnCodeCheck)
+ign_setup_target_for_codecheck()
+
+# Docs
+set(IGNITION_CMAKE_DOXYGEN_DIR "${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen")
+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, 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/).

doc/doxygen/api.in

@@ -2109,12 +2109,6 @@ EXTERNAL_GROUPS        = YES
 
 EXTERNAL_PAGES         = YES
 
-# The PERL_PATH should be the absolute path and name of the perl script
-# interpreter (i.e. the result of 'which perl').
-# The default file (with absolute path) is: /usr/bin/perl.
-
-PERL_PATH              = /usr/bin/perl
-
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
@@ -2128,15 +2122,6 @@ PERL_PATH              = /usr/bin/perl
 
 CLASS_DIAGRAMS         = NO
 
-# You can define message sequence charts within doxygen comments using the \msc
-# command. Doxygen will then run the mscgen tool (see:
-# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
-# documentation. The MSCGEN_PATH tag allows you to specify the directory where
-# the mscgen tool resides. If left empty the tool is assumed to be found in the
-# default search path.
-
-MSCGEN_PATH            =
-
 # You can include diagrams made with dia in doxygen documentation. Doxygen will
 # then run dia to produce the diagram and insert it in the documentation. The
 # DIA_PATH tag allows you to specify the directory where the dia binary resides.

examples/CMakeLists.txt

@@ -23,10 +23,6 @@ if (NOT CMAKE_GENERATOR MATCHES "Visual Studio")
   )
 endif()
 
-# test to see if we have programs necessary to run codecheck
-include(IgnCodeCheck)
-ign_setup_target_for_codecheck()
-
 foreach(example ${example_directories})
   set(run_codecheck false)
   if (${example} STREQUAL "ign_conf")

examples/comp_deps/child/include/empty.hh

@@ -0,0 +1,16 @@
+/*
+ * Copyright (C) 2018 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+*/

examples/comp_deps/parent/include/empty.hh

@@ -0,0 +1,16 @@
+/*
+ * Copyright (C) 2018 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+*/

examples/use_component_depsA/src/empty.cc

@@ -0,0 +1,16 @@
+/*
+ * Copyright (C) 2018 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+*/

examples/use_component_depsB/src/empty.cc

@@ -0,0 +1,16 @@
+/*
+ * Copyright (C) 2018 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+*/

examples/use_component_depsC/src/empty.cc

@@ -0,0 +1,16 @@
+/*
+ * Copyright (C) 2018 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+*/

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**
+
+1. \subpage install "Installation"
+
+## 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/).

tutorials/index.md

@@ -0,0 +1,6 @@
+# Introduction
+
+Ignition CMake is a component in the Ignition framework, a set
+of libraries designed to rapidly develop robot applications.
+
+[http://ignitionrobotics.org](http://ignitionrobotics.org)

tutorials/install.md

@@ -0,0 +1,130 @@
+\page install Installation
+
+# Install
+
+These instructions are for installing only Ignition CMake. If you're interested
+in using all the Ignition libraries, not only Igniton CMake, check out this
+[Ignition installation](https://ignitionrobotics.org/docs/latest/install).
+
+We recommend following the binary install instructions to get up and running as
+quickly and painlessly as possible.
+
+The source install instructions should be used if you need the very latest
+software improvements, if you need to modify the code, or if you plan to make a
+contribution.
+
+## Binary Install
+
+### Ubuntu
+
+On Ubuntu, it's possible to install Ignition CMake as follows:
+
+Add OSRF packages:
+
+    echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list
+    sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys D2486D2DD83DB69272AFE98867170598AF249743
+    sudo apt update
+
+Install Ignition CMake:
+
+    sudo apt install libignition-cmake<#>-dev
+
+Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
+which version you need.
+
+### macOS
+
+On macOS, add OSRF packages:
+
+    ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+    brew tap osrf/simulation
+
+Install Ignition CMake:
+
+    brew install ignition-cmake<#>
+
+Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
+which version you need.
+
+## Source Install
+
+### Prerequisites
+
+#### Ubuntu Bionic 18.04 or above
+
+Add OSRF packages:
+
+    sudo apt update
+    sudo apt -y install wget lsb-release gnupg
+    sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list'
+    wget http://packages.osrfoundation.org/gazebo.key -O - | apt-key add -
+    sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main"
+
+Clone source code:
+
+    # This checks out the `main` branch. You can append `-b ign-cmake#` (replace # with a number) to checkout a specific version
+    git clone http://github.com/ignitionrobotics/ign-cmake
+
+Install dependencies
+
+    sudo apt -y install $(sort -u $(find . -iname 'packages.apt') | tr '\n' ' ')
+
+Only on Bionic, update the GCC compiler version:
+
+    sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-8 800 --slave /usr/bin/g++ g++ /usr/bin/g++-8 --slave /usr/bin/gcov gcov /usr/bin/gcov-8
+
+
+### Building from source
+
+Build and install as follows:
+
+    cd ign-cmake
+    mkdir build
+    cd build
+    cmake ..
+    make -j4
+    sudo make install
+
+# Documentation
+
+API documentation and tutorials can be accessed at
+[https://ignitionrobotics.org/libs/cmake](https://ignitionrobotics.org/libs/cmake)
+
+You can also generate the documentation from a clone of this repository by following these steps.
+
+1. You will need [Doxygen](http://www.doxygen.org/). On Ubuntu Doxygen can be installed using
+
+        sudo apt-get install doxygen
+
+2. Clone the repository
+
+        git clone https://github.com/ignitionrobotics/ign-cmake
+
+3. Configure and build the documentation.
+
+        cd ign-cmake
+        mkdir build
+        cd build
+        cmake ..
+        make doc
+
+4. View the documentation by running the following command from the `build` directory.
+
+        firefox doxygen/html/index.html
+
+# Testing
+
+Follow these steps to run tests and static code analysis in your clone of this repository.
+
+1. Follow the [source install instruction](#source-install).
+
+2. Run tests.
+
+        make test
+
+3. Static code checker.
+
+        make codecheck
+
+See the [Writing Tests section of the contributor cmakede](https://ignitionrobotics.org/docs/all/contributing#writing-tests) for help creating or modifying tests.
+