From 353788a64537cc327cc5972f4c8c4b620ed2ae79 Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Wed, 14 Sep 2016 16:55:30 -0700 Subject: [PATCH] docs: renamed upm.hpp to a more appropriate doxygen.groups Signed-off-by: Mihai Tudor Panu --- docs/documentation.md | 2 +- doxy/Doxyfile.in | 2 +- doxy/Doxyfile.java.in | 2 +- src/{upm.hpp => doxygen.groups} | 1 - 4 files changed, 3 insertions(+), 4 deletions(-) rename src/{upm.hpp => doxygen.groups} (99%) diff --git a/docs/documentation.md b/docs/documentation.md index cac443b9..33b2f8d5 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -66,7 +66,7 @@ Here's an example (disregard the "@verbatim" tags in your actual code): - `` Specifies if the sensor is part of a kit. *Optional* Existing groups that can be used for the manufacturer, connection, category and -kit tags are found in the src/upm.hpp file. +kit tags are found in the *src/doxygen.groups* file. Optionally, a small representative image can be placed in the "docs/images" subfolder and linked with the "@image" tag. diff --git a/doxy/Doxyfile.in b/doxy/Doxyfile.in index ac39ab4a..520c326b 100644 --- a/doxy/Doxyfile.in +++ b/doxy/Doxyfile.in @@ -764,7 +764,7 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/upm.hpp \ +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/doxygen.groups \ @CMAKE_CURRENT_SOURCE_DIR@/src \ @CMAKE_CURRENT_SOURCE_DIR@/docs \ @CMAKE_CURRENT_SOURCE_DIR@/doxy/README.cpp.md diff --git a/doxy/Doxyfile.java.in b/doxy/Doxyfile.java.in index 97373e1c..43b2c2a7 100644 --- a/doxy/Doxyfile.java.in +++ b/doxy/Doxyfile.java.in @@ -764,7 +764,7 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/upm.hpp \ +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/doxygen.groups \ @CMAKE_BINARY_DIR@/src \ @CMAKE_CURRENT_SOURCE_DIR@/docs \ @CMAKE_CURRENT_SOURCE_DIR@/doxy/README.java.md diff --git a/src/upm.hpp b/src/doxygen.groups similarity index 99% rename from src/upm.hpp rename to src/doxygen.groups index f5e5591f..23b863fa 100644 --- a/src/upm.hpp +++ b/src/doxygen.groups @@ -22,7 +22,6 @@ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -#pragma once /// @cond DEV /**