Commit 7fc077ed authored by Nick Mathewson's avatar Nick Mathewson 🤹
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
Loading
Loading
Loading
Loading

src/app/app.dox

0 → 100644
+4 −0
Original line number Diff line number Diff line
/**
@dir app
@brief app
**/
+4 −0
Original line number Diff line number Diff line
/**
@dir app/config
@brief app/config
**/
+4 −0
Original line number Diff line number Diff line
/**
@dir app/main
@brief app/main
**/

src/core/core.dox

0 → 100644
+4 −0
Original line number Diff line number Diff line
/**
@dir core
@brief core
**/
+4 −0
Original line number Diff line number Diff line
/**
@dir core/crypto
@brief core/crypto
**/
Loading