make doxygen output nicer

pull/71/head
Gernot 10 months ago
parent 287bbb3c6a
commit ad1a6a032c
  1. BIN
      doc/misc/logo.png
  2. 17
      src/Doxyfile
  3. 5
      src/Makefile
  4. 2
      src/pEpEngine.h

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 KiB

@ -34,13 +34,13 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "pEp Engine"
PROJECT_NAME = "pp Engine"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER =
PROJECT_NUMBER = "3.1"
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@ -53,7 +53,7 @@ PROJECT_BRIEF =
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
PROJECT_LOGO =
PROJECT_LOGO = "../doc/misc/logo.png"
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
@ -130,7 +130,8 @@ ABBREVIATE_BRIEF = "The $name class" \
represents \
a \
an \
the
the \
"$name"
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
@ -893,7 +894,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = ../src ../asn.1
INPUT = ../src ../README.md \
../asn.1/Distribution.h ../asn.1/Distribution.h ../asn.1/ASN1Message.h ../asn.1/Sync.h ../asn.1/Storage.h
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -1092,7 +1094,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = "../README.md"
#---------------------------------------------------------------------------
# Configuration options related to source browsing
@ -1143,7 +1145,8 @@ REFERENCES_RELATION = YES
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
#nondefault
REFERENCES_LINK_SOURCE = NO
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,

@ -102,7 +102,7 @@ endif
$(TARGET): libpEpEngine.a
$(CC) -o $@ $(CPPFLAGS) $(LDFLAGS) $(CFLAGS) $(ALL_OBJECTS) $(LDLIBS)
.PHONY: objects clean install_headers install uninstall beinstall
.PHONY: objects clean install_headers install uninstall beinstall doc
objects: $(ALL_OBJECTS)
@ -151,3 +151,6 @@ tags: $(wildcard *.c) $(wildcard *.h)
doc:
doxygen
sed -i 's/≡/\$$\\equiv\$$/g' ../doc/api/latex/*.tex
make -C ../doc/api/latex

@ -557,7 +557,7 @@ DYNAMIC_API PEP_STATUS verify_text(
*
* @param[in] session session handle
* @param[in] keylist list of key ids to encrypt with as C strings
* @param[in] ptext plain text to decrypt and/or verify
* @param[in] ptext plain text to encrypt
* @param[in] psize size of plain text
* @param[out] ctext pointer to internal buffer with cipher text
* @param[out] csize size of cipher text

Loading…
Cancel
Save