Repository: mesos Updated Branches: refs/heads/master 3af834941 -> 9987b4652
Slightly improved Doxygen-Styleguide. Clarifies items in the discussions arising from https://reviews.apache.org/r/36141/. Adds example for @see and removes @todo, which should be used outside of Doxygen comments only. Review: https://reviews.apache.org/r/36193 Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/9987b465 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/9987b465 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/9987b465 Branch: refs/heads/master Commit: 9987b465205c1e9a74298972fe2c707ae3e3f92a Parents: 3af8349 Author: Joerg Schad <[email protected]> Authored: Thu Jul 9 12:43:07 2015 +0200 Committer: Bernd Mathiske <[email protected]> Committed: Thu Jul 9 12:43:07 2015 +0200 ---------------------------------------------------------------------- docs/mesos-doxygen-style-guide.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/9987b465/docs/mesos-doxygen-style-guide.md ---------------------------------------------------------------------- diff --git a/docs/mesos-doxygen-style-guide.md b/docs/mesos-doxygen-style-guide.md index 72156c7..e6433df 100644 --- a/docs/mesos-doxygen-style-guide.md +++ b/docs/mesos-doxygen-style-guide.md @@ -54,10 +54,18 @@ This is the allowed set of doxygen tags that can be used. * [\@param](http://doxygen.org/manual/commands.html#cmdparam) Describes function parameters. * [\@return](http://doxygen.org/manual/commands.html#cmdreturn) Describes return values. * [\@see](http://doxygen.org/manual/commands.html#cmdsa) Describes a cross-reference to classes, functions, methods, variables, files or URL. + +Example: + + /** + * Available kinds of implementations. + * + * @see process::network::PollSocketImpl + */ + * [\@file](http://doxygen.org/manual/commands.html#cmdfile) Describes a refence to a file. It is required when documenting global functions, variables, typedefs, or enums in separate files. * [\@link](http://doxygen.org/manual/commands.html#cmdlink) and [\@endlink](http://doxygen.org/manual/commands.html#cmdendlink) Describes a link to a file, class, or member. * [\@example](http://doxygen.org/manual/commands.html#cmdexample) Describes source code examples. - * [\@todo](http://doxygen.org/manual/commands.html#cmdtodo) Describes a TODO item. * [\@image](http://doxygen.org/manual/commands.html#cmdimage) Describes an image. * When following these links be aware that the doxygen documentation is using another syntax in that \@param is explained as \\param.
