Skip to content

Commit c1f018c

Browse files
committed
tweaking the documentation generation
1 parent 2283336 commit c1f018c

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ run: test
5252
./$(BUILD)/examples/$(EXAMPLE)
5353

5454
doc:
55-
cd docs; doxygen Doxyfile
55+
doxygen docs/Doxyfile
5656

5757
release: test
5858

docs/Doxyfile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Doxyfile 1.9.4
2+
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
23

34
# This file describes the settings to be used by the documentation system
45
# doxygen (www.doxygen.org) for a project.
@@ -53,14 +54,14 @@ PROJECT_NUMBER =
5354
# for a project that appears at the top of each page and should give viewer a
5455
# quick idea about the purpose of the project. Keep the description short.
5556

56-
PROJECT_BRIEF =
57+
PROJECT_BRIEF = Building Block For Asynchronous Programs
5758

5859
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
5960
# in the documentation. The maximum height of the logo should not exceed 55
6061
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
6162
# the logo to the output directory.
6263

63-
PROJECT_LOGO = beman-logo.png
64+
PROJECT_LOGO = docs/beman-logo.png
6465

6566
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
6667
# into which the generated documentation will be written. If a relative path is
@@ -906,7 +907,7 @@ WARN_LOGFILE =
906907
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
907908
# Note: If this tag is empty the current directory is searched.
908909

909-
INPUT = ../include/beman ../src/beman
910+
INPUT = include/beman src/beman docs
910911

911912
# This tag can be used to specify the character encoding of the source files
912913
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

0 commit comments

Comments
 (0)