diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-11-03 15:15:07 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-11-04 07:40:14 -0500 |
| commit | 7fc077ed2558c8174237388d00924fd139f786ce (patch) | |
| tree | 164c006fc6396ce6fc09b33ea74130a2de59d60e /src/app | |
| parent | afc267e8872f0cb780d8c8bd7c0ea4e1d1683a87 (diff) | |
| download | tor-7fc077ed2558c8174237388d00924fd139f786ce.tar.gz tor-7fc077ed2558c8174237388d00924fd139f786ce.zip | |
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
Diffstat (limited to 'src/app')
| -rw-r--r-- | src/app/app.dox | 4 | ||||
| -rw-r--r-- | src/app/config/app_config.dox | 4 | ||||
| -rw-r--r-- | src/app/main/app_main.dox | 4 |
3 files changed, 12 insertions, 0 deletions
diff --git a/src/app/app.dox b/src/app/app.dox new file mode 100644 index 0000000000..8c37d9275b --- /dev/null +++ b/src/app/app.dox @@ -0,0 +1,4 @@ +/** +@dir app +@brief app +**/ diff --git a/src/app/config/app_config.dox b/src/app/config/app_config.dox new file mode 100644 index 0000000000..03762fd27d --- /dev/null +++ b/src/app/config/app_config.dox @@ -0,0 +1,4 @@ +/** +@dir app/config +@brief app/config +**/ diff --git a/src/app/main/app_main.dox b/src/app/main/app_main.dox new file mode 100644 index 0000000000..1d94f89814 --- /dev/null +++ b/src/app/main/app_main.dox @@ -0,0 +1,4 @@ +/** +@dir app/main +@brief app/main +**/ |