Skip to content

Commit 576af65

Browse files
committed
Update documentation files and community logo
- Updated Doxyfile and doc/CMakeLists.txt for improved documentation generation - Replaced PiduinoCommunityLogo images (PNG and SVG) with new versions
1 parent 4fcf871 commit 576af65

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

Doxyfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8
4242
# title of most generated pages and in a few other places.
4343
# The default value is: My Project.
4444

45-
PROJECT_NAME = PiDuino
45+
PROJECT_NAME = "PIDUINO"
4646

4747
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4848
# could be handy for archiving the generated documentation or if some version
@@ -54,14 +54,14 @@ PROJECT_NUMBER =
5454
# for a project that appears at the top of each page and should give viewer a
5555
# quick idea about the purpose of the project. Keep the description short.
5656

57-
PROJECT_BRIEF = "Arduino on Pi boards, the best of both worlds !"
57+
PROJECT_BRIEF =
5858

5959
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
6060
# in the documentation. The maximum height of the logo should not exceed 55
6161
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
6262
# the logo to the output directory.
6363

64-
PROJECT_LOGO = doc/images/PiduinoLogoSmall.png
64+
PROJECT_LOGO = doc/images/PiduinoCommunityLogo.png
6565

6666
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
6767
# into which the generated documentation will be written. If a relative path is

doc/CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ if (PIDUINO_WITH_DOXYGEN_DOC)
3636
message(FATAL_ERROR "sed is required but was not found. Please install sed.")
3737
endif()
3838

39-
set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
39+
set(DOXYFILE_IN ${PROJECT_SOURCE_DIR}/Doxyfile)
4040
set(DOXYFILE_BUILD ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
4141
# You must set the following variables to point to your project's files
4242
set(DOXY_README "${PROJECT_SOURCE_DIR}/README.md")
4343
set(DOXY_INPUT ${DOXY_README} ${PROJECT_SOURCE_DIR}/include/piduino)
4444
set(DOXY_IMAGE_PATH "${PROJECT_SOURCE_DIR}/doc/images")
45-
set(DOXY_PROJECT_LOGO "${PROJECT_SOURCE_DIR}/doc/images/PiduinoLogoSmall.png")
45+
set(DOXY_PROJECT_LOGO "${PROJECT_SOURCE_DIR}/doc/images/PiduinoCommunityLogo.png")
4646
set(DOXY_EXAMPLE_PATH "${PROJECT_SOURCE_DIR}/examples")
4747

4848
# replace placeholders in the Doxyfile for local generation
-13.6 KB
Loading

doc/images/PiduinoCommunityLogo.svg

Lines changed: 7 additions & 7 deletions
Loading

0 commit comments

Comments
 (0)