linerrating.blogg.se - Doxygen comment examples

#Doxygen comment examples code

Documentation should begin in the first column (except for nested lists).

The documentation will then be generated into the. There are no longer any references to the associatedĪs of right now, the Doxygen documentation should be built from the build subdirectory using doxygen. * input / output file descriptors are only closed after: * input / output of the process, as well as the exit status. * Represents a fork() exec()ed subprocess. * The subprocess or an error if one occurred.Ĭonst Subprocess::IO& in = Subprocess::FD(STDIN_FILENO),Ĭonst Subprocess::IO& out = Subprocess::FD(STDOUT_FILENO),Ĭonst Subprocess::IO& err = Subprocess::FD(STDERR_FILENO), * clone Function to be invoked in order to fork/clone the

#Doxygen comment examples code

* async unsafe code in the body of this function. * setup Function to be invoked after forking but before * will inherit the environment of the current process. * subprocess or if None (the default) then the new subprocess * environment Environment variables to use for the new * flags Flags to be stringified and appended to 'argv'.

* err Redirection specification for stderr. * out Redirection specification for stdout. * in Redirection specification for stdin. * path Relative or absolute path in the filesytem to the * then that gets returned in 'status()' and we will not exec. If the return value of 'setup' is non-zero * If 'setup' is not None, runs the specified function after forking * specified by 'in', 'out', and 'err' respectively. * specified 'argv', redirecting stdin, stdout, and stderr as * Forks a subprocess and execs the specified 'path' with the * **NOTE**: stdin is a macro on some systems, hence this name instead. * If the mode is not PIPE, None will be stored. * those created by Mesos from those created manually.Įxtern const std::string DOCKER_NAME_PREFIX * Prefix used to name Docker containers in order to distinguish * a very long description and an even longer * uncompressed The input string that requires We wrap long descriptions using four spaces on the next line: /** When following these links be aware that the Doxygen documentation uses the \param syntax rather than Wrapping and Describes a link to a file, class, or member.It is required when documenting global functions, variables, typedefs, or enums in separate files.

Describes a cross-reference to classes, functions, methods, variables, files or URL.

This is the allowed set of doxygen tags that can be used. Std::string compress(const std::string& uncompressed) * A compressed version of the input string. * Compresses an input string using the foobar algorithm. * Returns a compressed version of a string. We follow the Javadoc syntax to mark comment blocks. Implementation code that does not participate in this should still beĮnhanced by source code comments as appropriate, but these comments should not follow the doxygen style. Source Code Documentation Syntaxĭoxygen documentation needs only to be applied to source code parts thatĬonstitute an interface for which we want to generate Mesos API documentationįiles. There is an ongoing, incremental effort with the goal to document all public Mesos, libprocess, and stout APIs this way.įor now, existing code may not follow these guidelines, but new code should.