forked from eclipse-iceoryx/iceoryx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/master' into iox-eclipse-iceoryx…
…#136-mkdocs-export-for-website
- Loading branch information
Showing
33 changed files
with
542 additions
and
7,533 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# Copyright (c) 2021 Apex.AI Inc. All rights reserved. | ||
# | ||
# 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. | ||
# | ||
|
||
cmake_minimum_required(VERSION 3.10) | ||
|
||
file(STRINGS "../../VERSION" iceoryx_doc_VERSION) | ||
project(iceoryx_doc VERSION ${iceoryx_doc_VERSION}) | ||
|
||
find_package(Doxygen REQUIRED) | ||
|
||
set(DOXYGEN_GENERATE_HTML YES) | ||
set(DOXYGEN_GENERATE_LATEX YES) | ||
set(DOXYGEN_GENERATE_XML YES) | ||
set(DOXYGEN_XML_OUTPUT xml) | ||
|
||
if(EXISTS "/usr/share/plantuml/plantuml.jar") | ||
set(DOXYGEN_PLANTUML_JAR_PATH /usr/share/plantuml/plantuml.jar) | ||
else() | ||
if(DEFINED $ENV{PLANTUML_JAR_PATH}) | ||
set(DOXYGEN_PLANTUML_JAR_PATH | ||
"$ENV{PLANTUML_JAR_PATH}" | ||
CACHE STRING "PLANTUML location.") | ||
else() | ||
message( | ||
WARNING | ||
"plantuml.jar not found at '/usr/share/plantuml/', please set environment variable PLANTUML_JAR_PATH to the correct location." | ||
) | ||
endif() | ||
endif() | ||
|
||
set(DOXYGEN_ALIASES | ||
[["concurrent=\xrefitem concurrent \"Concurrent\" \"Concurrency\" " \ | ||
"req=\xrefitem req \"Requirement\" \"Requirements\" " \ | ||
"link=\xrefitem link \"Link\" \"Links\" " \ | ||
swcomponent="@par Software Component:" \ | ||
error="@par Error Handling:" \ | ||
generatedcode="@par Generated by:"]]) | ||
|
||
set(COMPONENTS iceoryx_utils iceoryx_posh iceoryx_binding_c iceoryx_dds | ||
iceoryx_introspection iceoryx_component) | ||
set(COMPONENT_DIRS | ||
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_utils | ||
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_posh | ||
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_binding_c | ||
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_dds | ||
${CMAKE_CURRENT_SOURCE_DIR}/../../tools/introspection | ||
${CMAKE_CURRENT_SOURCE_DIR}/example/iceoryx_component) | ||
|
||
|
||
list(LENGTH COMPONENTS tmp_len) | ||
math(EXPR cmp_len "${tmp_len} - 1") | ||
|
||
foreach(val RANGE ${cmp_len}) | ||
list(GET COMPONENTS ${val} cmp) | ||
list(GET COMPONENT_DIRS ${val} cmp_dir) | ||
message(STATUS "${cmp} ${cmp_dir}") | ||
|
||
set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/doc/${cmp}) | ||
|
||
doxygen_add_docs(doxygen_${cmp} ${cmp_dir}/include | ||
${cmp_dir}/source ${cmp_dir}/test ALL) | ||
endforeach() | ||
|
||
# create dummy install directive to generate docu also with "make install" | ||
install( | ||
FILES | ||
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.doxygen_iceoryx_utils | ||
DESTINATION | ||
${CMAKE_CURRENT_BINARY_DIR} | ||
) |
Empty file.
Oops, something went wrong.