Browse Source

added target doc; added demo documentation; added automatic plantuml detection (Download and install http://de.plantuml.com/).

merge-requests/365/head
Goto40 10 years ago
parent
commit
6cf4d697ab
  1. 18
      src/CMakeLists.txt
  2. 2384
      src/Doxyfile.in
  3. 9
      src/cmake/Modules/FindPlantuml.cmake
  4. 26
      src/doc.h

18
src/CMakeLists.txt

@ -141,3 +141,21 @@ target_link_libraries(${project_name} ${global_libraries})
install(TARGETS ${project_name} install(TARGETS ${project_name}
RUNTIME DESTINATION bin RUNTIME DESTINATION bin
) )
find_package(Plantuml)
if(PLANTUML_FOUND)
#message("plantuml found PLANTUML_JARFILE=${PLANTUML_JARFILE}")
else(Plantuml_FOUND)
message("plantuml not found. No UML diagrams are generated. You may define the environment variable PLANTUML_PATH...")
endif(PLANTUML_FOUND)
# add a target to generate API documentation with Doxygen
find_package(Doxygen)
if(DOXYGEN_FOUND)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(doc
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen to ${CMAKE_CURRENT_BINARY_DIR}" VERBATIM
)
endif(DOXYGEN_FOUND)

2384
src/Doxyfile.in

File diff suppressed because it is too large Load Diff

9
src/cmake/Modules/FindPlantuml.cmake

@ -0,0 +1,9 @@
if(NOT DEFINED plantuml_FOUND)
find_file(PLANTUML_JARFILE
NAMES plantuml.jar
HINTS "$ENV{PLANTUML_PATH}" ENV PLANTUML_DIR
)
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(
plantuml DEFAULT_MSG PLANTUML_JARFILE)
endif()

26
src/doc.h

@ -0,0 +1,26 @@
/**
\mainpage
juCi++ is a lightweight C++ IDE written in C++
(<a href="https://github.com/cppit/jucipp">Github page</a>).
\section sec_overview Overview
The application entry point is the class Application.
\section sec_dependencies Dependencies
juCi++ is based on boost, gtkmm and libclang (among others).
\startuml
left to right direction
component [juCi++] #LightGreen
component [libclangmm] #Cyan
component [tiny-process-library] #Cyan
[juCi++] --> [boost-filesystem] : use
[juCi++] --> [boost-regex] : use
[juCi++] --> [gtkmm-3.0] : use
[juCi++] --> [gtksourceviewmm-3.0] : use
[juCi++] --> [aspell] : use
[juCi++] --> [lbclang] : use
[juCi++] --> [lbdb] : use
[juCi++] --> [libclangmm] : use
[juCi++] --> [tiny-process-library] : use
\enduml
*/
Loading…
Cancel
Save