Skip to content

Commit 1491a9b

Browse files
authored
Correct path to README.md and include that into the API doc. (unicode-org#150)
1 parent c743a28 commit 1491a9b

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

inflection/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
Copyright 2016-2024 Apple Inc. All rights reserved.
33
-->
4-
# Inflection
4+
# Inflection {#mainpage}
55

66
## About Unicode Inflection
77

@@ -125,4 +125,4 @@ cmake --build . -j8 -t check
125125
Optionally, ICU_ROOT can be specified in the file options.mk with the following type of syntax.
126126
```
127127
ICU_ROOT=<PATH_TO_ICU>
128-
```
128+
```

inflection/docs/Doxyfile

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -943,9 +943,8 @@ WARN_LOGFILE =
943943
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
944944
# Note: If this tag is empty the current directory is searched.
945945

946-
INPUT = ../../build/headers \
947-
../../build/inflection_headers \
948-
../README.md
946+
INPUT = ../../build/inflection_headers \
947+
../../README.md
949948

950949
# This tag can be used to specify the character encoding of the source files
951950
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1142,7 +1141,7 @@ FILTER_SOURCE_PATTERNS =
11421141
# (index.html). This can be useful if you have a project on for instance GitHub
11431142
# and want to reuse the introduction page also for the doxygen output.
11441143

1145-
USE_MDFILE_AS_MAINPAGE = ../README.md
1144+
USE_MDFILE_AS_MAINPAGE = ../../README.md
11461145

11471146
# The Fortran standard specifies that for fixed formatted Fortran code all
11481147
# characters from position 72 are to be considered as comment. A common

0 commit comments

Comments
 (0)