Lines Matching full:documentation

18 .. note:: Conventions on comments and documentation are not checked by
45 "Normal" comments (i.e. ``//``, rather than code documentation which starts
46 with ``///`` or ``//!``) are written in Markdown the same way as documentation
56 Furthermore, just like documentation, comments are capitalized at the beginning
64 Comments should not be used for documentation purposes: comments are intended
67 sometimes it is useful to use both comments and documentation at the same time.
68 For instance, for a ``TODO`` list or to comment on the documentation itself.
70 the line of documentation to be commented. For any other case, comments are
71 written after the documentation, e.g.:
98 in code documentation. ``# Safety`` sections specify the contract that callers
105 Code documentation
175 To learn more about how to write documentation for Rust and extra features,
178 	https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html
216 The equivalent in Rust may look like (ignoring documentation):