From bd6bd7d28eb2718b6c2bfd9fa60d1a855d177f5d Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Tue, 5 Nov 2019 12:52:28 -0500 Subject: [PATCH 1/2] Doxygen: enable source code browser --- Doxyfile.in | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Doxyfile.in b/Doxyfile.in index be500bbfa8..4569df5450 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -984,7 +984,7 @@ USE_MDFILE_AS_MAINPAGE = # also VERBATIM_HEADERS is set to NO. # The default value is: NO. -SOURCE_BROWSER = NO +SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. @@ -997,13 +997,13 @@ INLINE_SOURCES = NO # Fortran comments will always remain visible. # The default value is: YES. -STRIP_CODE_COMMENTS = YES +STRIP_CODE_COMMENTS = NO # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # entity all documented functions referencing it will be listed. # The default value is: NO. -REFERENCED_BY_RELATION = NO +REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. From d7872b775d77fb40a88695b5bea11f751262ad1f Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Tue, 5 Nov 2019 13:04:51 -0500 Subject: [PATCH 2/2] Doxygen: provide a style sheet This sheet tries to make links to the source code browser less obtrusive. --- Doxyfile.in | 2 +- doc/include.am | 1 + doc/tor-doxygen.css | 10 ++++++++++ 3 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 doc/tor-doxygen.css diff --git a/Doxyfile.in b/Doxyfile.in index 4569df5450..a4e4445cc8 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -1162,7 +1162,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = doc/tor-doxygen.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note diff --git a/doc/include.am b/doc/include.am index a9d3fa1c98..8651f845eb 100644 --- a/doc/include.am +++ b/doc/include.am @@ -47,6 +47,7 @@ EXTRA_DIST+= doc/asciidoc-helper.sh \ $(html_in) $(man_in) $(txt_in) \ doc/state-contents.txt \ doc/torrc_format.txt \ + doc/tor-doxygen.css \ doc/TUNING \ doc/HACKING/README.1st.md \ doc/HACKING/CodingStandards.md \ diff --git a/doc/tor-doxygen.css b/doc/tor-doxygen.css new file mode 100644 index 0000000000..97cd1886db --- /dev/null +++ b/doc/tor-doxygen.css @@ -0,0 +1,10 @@ + +p.definition { + font-size: small; + padding-left: 1.5em; +} + +p.reference { + font-size: small; + padding-left: 1.5em; +}