Skip to content
Snippets Groups Projects
Commit 7fc077ed authored by Nick Mathewson's avatar Nick Mathewson :game_die:
Browse files

Add stub directory-level documentation for most source directories

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
parent afc267e8
No related branches found
No related tags found
No related merge requests found
Showing
with 80 additions and 0 deletions
/**
@dir app
@brief app
**/
/**
@dir app/config
@brief app/config
**/
/**
@dir app/main
@brief app/main
**/
/**
@dir core
@brief core
**/
/**
@dir core/crypto
@brief core/crypto
**/
/**
@dir core/mainloop
@brief core/mainloop
**/
/**
@dir core/or
@brief core/or
**/
/**
@dir core/proto
@brief core/proto
**/
/**
@dir feature/api
@brief feature/api
**/
/**
@dir feature/client
@brief feature/client
**/
/**
@dir feature/control
@brief feature/control
**/
/**
@dir feature/dirauth
@brief feature/dirauth
**/
/**
@dir feature/dircache
@brief feature/dircache
**/
/**
@dir feature/dirclient
@brief feature/dirclient
**/
/**
@dir feature/dircommon
@brief feature/dircommon
**/
/**
@dir feature/dirparse
@brief feature/dirparse
**/
/**
@dir feature
@brief feature
**/
/**
@dir feature/hibernate
@brief feature/hibernate
**/
/**
@dir feature/hs
@brief feature/hs
**/
/**
@dir feature/hs_common
@brief feature/hs_common
**/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment