Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doxygen org #1492

Merged
merged 5 commits into from Nov 4, 2019
Merged

Doxygen org #1492

merged 5 commits into from Nov 4, 2019

Conversation

Reviewers

@vnepveu vnepveu

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
4 participants
@nmathewson @coveralls @vnepveu @torproject-pusher
@nmathewson
Copy link
Contributor

@nmathewson nmathewson commented Nov 4, 2019

No description provided.

nmathewson added 5 commits Nov 3, 2019
@nmathewson
Doxygen: accept .dox as pure doxygen, and interpret everything as C
7ec314a
@nmathewson
Doxygen: Better path handling.
e2da29e 
This change tells doxygen to include all files not explicitly
excluded, and to document paths along with filenames.
@nmathewson
Add a stub main page for the documentation.
afc267e
@nmathewson
Add stub directory-level documentation for most source directories
7fc077e 
This includes app, core, feature, lib, and tools, but excludes
ext, test, and trunnel.

This was generated by the following shell script:

cd src
for dname in $(find lib core feature app tools -type d |grep -v \\.deps$); do
    keyword="$(echo "$dname" |sed -e "s/\//_/" )"
    target="${dname}/${keyword}.dox"
    echo "$target"
    cat <<EOF >"$target"
/**
@dir ${dname}
@brief ${dname}
**/
EOF

    git add "$target"
done
@nmathewson
Document our top-level directories
d3af237
@coveralls
Copy link

@coveralls coveralls commented Nov 4, 2019

Pull Request Test Coverage Report for Build 7046

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-0.001%) to 62.129%
Files with Coverage Reduction New Missed Lines %
src/feature/hs/hs_common.c 1 84.27%
Totals Coverage Status
Change from base Build 7037: -0.001%
Covered Lines: 48342
Relevant Lines: 77809
💛 - Coveralls

@torproject-pusher torproject-pusher merged commit d3af237 into torproject:master Nov 4, 2019
2 checks passed
vnepveu
vnepveu reviewed Nov 4, 2019
View changes
Copy link
Contributor

@vnepveu vnepveu left a comment •
edited

Changes introduced by the commits seem pretty clear

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment