Repository: mesos Updated Branches: refs/heads/master b56b3b049 -> 68b8595f0
Doxygen styleguide revisions. See conversation at https://reviews.apache.org/r/36193. Review: https://reviews.apache.org/r/36218 Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/68b8595f Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/68b8595f Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/68b8595f Branch: refs/heads/master Commit: 68b8595f0f54110a7edc2b56212db01ab08d30ab Parents: 8cbf894 Author: Joseph Wu <[email protected]> Authored: Thu Jul 9 15:11:03 2015 -0700 Committer: Benjamin Hindman <[email protected]> Committed: Thu Jul 9 15:13:08 2015 -0700 ---------------------------------------------------------------------- docs/mesos-doxygen-style-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/68b8595f/docs/mesos-doxygen-style-guide.md ---------------------------------------------------------------------- diff --git a/docs/mesos-doxygen-style-guide.md b/docs/mesos-doxygen-style-guide.md index e6433df..1bd3b3d 100644 --- a/docs/mesos-doxygen-style-guide.md +++ b/docs/mesos-doxygen-style-guide.md @@ -98,7 +98,7 @@ Example: /** * The parent side of the pipe for stdin. * If the mode is not PIPE, None will be stored. - * @note: stdin is a macro on some systems, hence this name instead. + * **NOTE**: stdin is a macro on some systems, hence this name instead. */ Option<int> in; @@ -170,7 +170,7 @@ stout, libprocess, master, slave, containerizer, allocator, and others should have an overview page in markdown format that explains their purpose, overall structure, and general use. This can even be a complete developer guide. -This page must be located in the top directory of the library/component and named "REAMDE.md". +This page must be located in the top directory of the library/component and named "README.md". The first line in such a document must be a section heading bearing the title which will appear in the generated Doxygen index. Example: "# Libprocess Developer Guide"
