| /openbsd-src/gnu/llvm/clang/include/clang/StaticAnalyzer/Checkers/ |
| H A D | Checkers.td | 134 Documentation<HasDocumentation>,
189 Documentation<HasDocumentation>,
201 Documentation<HasDocumentation>;
206 Documentation<HasDocumentation>;
210 Documentation<HasDocumentation>;
214 Documentation<HasDocumentation>;
218 Documentation<HasDocumentation>;
222 Documentation<NotDocumented>,
228 Documentation<HasDocumentation>;
232 Documentation<NotDocumented>,
[all …]
|
| /openbsd-src/gnu/llvm/clang/include/clang/Basic/ |
| H A D | Attr.td | 9 // The documentation is organized by category. Attributes can have category-
10 // specific documentation that is collated within the larger document.
27 currently missing documentation.
32 // in the documentation. This category should be used only when we _want_
38 // documentation. Otherwise, the documentation will specify the attribute has
43 // Specifies the documentation to be associated with the given category.
44 class Documentation {
60 // Specifies that the attribute is explicitly omitted from the documentation,
62 def InternalOnly : Documentation {
67 // documentation.
[all …]
|
| H A D | DiagnosticCommentKinds.td | 10 let CategoryName = "Documentation Issue" in {
17 InGroup<Documentation>, DefaultIgnore;
21 InGroup<Documentation>, DefaultIgnore;
51 InGroup<Documentation>, DefaultIgnore;
55 InGroup<Documentation>, DefaultIgnore;
68 InGroup<Documentation>, DefaultIgnore;
77 InGroup<Documentation>, DefaultIgnore;
84 InGroup<Documentation>, DefaultIgnore;
90 InGroup<Documentation>, DefaultIgnore;
96 InGroup<Documentation>, DefaultIgnore;
[all …]
|
| H A D | AttrDocs.td | 1 //==--- AttrDocs.td - Attribute documentation ----------------------------===//
9 // To test that the documentation builds cleanly, you must run clang-tblgen to
51 def SectionDocs : Documentation {
60 def UsedDocs : Documentation {
81 documentation for further information.
85 def RetainDocs : Documentation {
109 def InitPriorityDocs : Documentation {
139 def InitSegDocs : Documentation {
149 documentation on MSDN for more information.
155 def TLSModelDocs : Documentation {
[all …]
|
| /openbsd-src/gnu/usr.bin/perl/pod/ |
| H A D | perldocstyle.pod | 5 perldocstyle - A style guide for writing Perl's documentation
10 documentation that ships with Perl. This includes the following:
21 The documentation for all the modules included with Perl (as listed by
37 applicable to Perl's core documentation.
41 with the rest of the Perl project, the language's documentation
48 more welcome and engaged with Perl's documentation, and this in turn
54 Anyone interested in contributing to Perl's core documentation should
64 documentation style guides of several open-source technologies
69 which to launch a review of Perl's reams of extant documentation, with
78 All of Perl's core documentation uses Pod ("Plain Old Documentation"), a
[all …]
|
| H A D | perl588delta.pod | 41 Documentation typo fix
90 Documentation typo fix
151 Enhanced documentation
195 Enhanced documentation and typo fixes
293 Enhanced documentation
305 Documentation typo fix
321 Documentation tweaks and typo fixes
337 Enhanced documentation including MD5 weaknesses discovered lately
349 Documentation fix
370 C<bootstrap_inherit()> and documentation enhancements.
[all …]
|
| H A D | perlpodstyle.pod | 7 These are general guidelines for how to write POD documentation for Perl
10 them will make your documentation more consistent with other documentation
23 when referring to module documentation since it's not clear what section
24 module documentation will be in; use C<LE<lt>Module::NameE<gt>> for module
30 to clutter your documentation with too much markup. References to other
64 mandatory for section 3 pages. For Perl module documentation, it's
71 body of the documentation for man pages that document something else. If
81 or whatever is appropriate for your documentation.
83 For a module, this is generally where the documentation of the interfaces
86 you may want to put that documentation in separate METHODS, FUNCTIONS,
[all …]
|
| H A D | perlmodstyle.pod | 108 =head2 Documentation section in QUICK CHECKLIST
114 Write documentation in POD
126 Give examples of use in your documentation
477 Your module should include documentation aimed at Perl developers.
478 You should use Perl's "plain old documentation" (POD) for your general
479 technical documentation, though you may wish to write additional
480 documentation (white papers, tutorials, etc) in some other format.
512 The level of detail in Perl module documentation generally goes from
526 The recommended order of sections in Perl module documentation is:
565 Keep your documentation near the code it documents ("inline"
[all …]
|
| /openbsd-src/gnu/usr.bin/perl/Porting/ |
| H A D | docs-team-charter.pod | 3 docs-team-charter - Perl Documentation Team Charter
7 This is the founding charter for the Perl Documentation Team.
9 The Perl project has a documentation sub-project, responsible for
10 maintaining the quality and consistency of Perl's core documentation.
12 This project is managed by the Documentation Team (a.k.a. "Docs Team").
18 The Perl Documentation Team oversees the quality, accessibility, and
19 maintainability of Perl's core documentation.
27 =item Perl's core documentation
29 By "core documentation", we mean all the documentation that ships with
31 documentation attached to standard modules.
[all …]
|
| /openbsd-src/gnu/gcc/libstdc++-v3/docs/doxygen/ |
| H A D | mainpage.html | 24 <h1>libstdc++ Source Documentation</h1>
26 <h2>Documentation Overview</h2>
30 <p>There are two types of documentation for libstdc++. One is the
31 distribution documentation, which can be read online at
32 …http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">http://gcc.gnu.org/onlinedocs/libstdc+…
33 or offline from docs/html/documentation.html in the library source
37 <p>The other type is the source documentation, of which this is the first page.
39 documentation is produced: user-level docs are for the users of this
66 local copy of the source documentation for faster viewing, you can use
71 <h2>Generating the documentation</h2>
[all …]
|
| H A D | user.cfg.in | 3 # This file describes the settings to be used by the documentation system
23 # This could be handy for archiving the generated documentation or
29 # base path where the generated documentation will be put.
45 # documentation generated by doxygen is written. Doxygen will use this
69 # the file and class documentation (similar to JavaDoc).
101 # all inherited members of a class in the documentation of that class
124 # the path mentioned in the documentation of a class, which tells
157 # documentation.
162 # member inherits the documentation from any documented member that it
168 # a new page for each member. If set to NO, the documentation of a member will
[all …]
|
| /openbsd-src/gnu/llvm/clang/include/clang/Tooling/Syntax/ |
| H A D | Nodes.td | 21 let documentation = [{
36 let documentation = [{
47 let documentation = [{
58 let documentation = [{
63 let documentation = [{
75 let documentation = [{
83 let documentation = [{
95 let documentation = [{
106 let documentation = [{
114 let documentation = [{
[all …]
|
| /openbsd-src/gnu/lib/libstdc++/libstdc++/docs/doxygen/ |
| H A D | mainpage.html | 24 <h1>libstdc++-v3 Source Documentation</h1>
26 <h2>Documentation Overview</h2>
30 <p>There are two types of documentation for libstdc++-v3. One is the
31 distribution documentation, which can be read online at
32 …http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">http://gcc.gnu.org/onlinedocs/libstdc+…
33 or offline from docs/html/documentation.html in the library source
37 <p>The other type is the source documentation, of which this is the first page.
39 documentation is produced: user-level docs are for the users of this
104 <p>The libstdc++-v3 documentation is released under
108 <p>Part of the generated documentation involved comments
[all …]
|
| H A D | user.cfg.in | 3 # This file describes the settings to be used by the documentation system
30 # This could be handy for archiving the generated documentation or
36 # base path where the generated documentation will be put.
43 # documentation generated by doxygen is written. Doxygen will use this
54 # documentation are documented, even if no documentation was available.
61 # will be included in the documentation.
66 # will be included in the documentation.
71 # defined locally in source files will be included in the documentation.
79 # various overviews, but no documentation section is generated.
94 # documentation.
[all …]
|
| /openbsd-src/gnu/llvm/llvm/docs/ |
| H A D | README.txt | 1 LLVM Documentation
4 LLVM's documentation is written in reStructuredText, a lightweight
6 reStructuredText documentation should be quite readable in source form, it
7 is mostly meant to be processed by the Sphinx documentation generation
19 The mapping between reStructuredText files and generated documentation is
22 If you are interested in writing new documentation, you will want to read
23 `SphinxQuickstartTemplate.rst` which will get you writing documentation
30 Building the manpages is similar to building the HTML documentation. The
49 The reachability of external links in the documentation can be checked by
|
| H A D | SphinxQuickstartTemplate.rst | 5 …n the state of “I want to write documentation and get it added to LLVM’s docs” and help them start…
13 …documentation is written in `reStructuredText`_, a markup syntax similar to markdown (but much mor…
50 …make your articles task-oriented. You generally should not be writing documentation that isn't bas…
60 this file into a new file for the documentation you are about to write.
168 Generating the documentation
171 You can generate the HTML documentation from the sources locally if you want to
189 Then run cmake to build the documentation inside the ``llvm-project`` checkout:
201 After that you find the generated documentation in ``build/docs/html``
|
| H A D | doxygen.cfg.in | 3 # This file describes the settings to be used by the documentation system
31 # project for which the documentation is generated. This name is used in the
38 # could be handy for archiving the generated documentation or if some version
50 # the documentation. The maximum height of the logo should not exceed 55 pixels
57 # into which the generated documentation will be written. If a relative path is
74 # documentation generated by doxygen is written. Doxygen will use this
90 # documentation (similar to Javadoc). Set to NO to disable this.
123 # inherited members of a class in the documentation of that class as if those
150 # path mentioned in the documentation of a class, which tells the reader which
196 # documentation from any documented member that it re-implements.
[all …]
|
| H A D | MarkdownQuickstartTemplate.md | 5 This document is meant to get you writing documentation as fast as possible
7 someone in the state of "I want to write documentation and get it added to
8 LLVM's docs" and turn that into useful documentation mailed to llvm-commits
45 You generally should not be writing documentation other than a "how to"
54 this file into a new file for the documentation you are about to write.
154 integration documentation can be found in the [recommonmark docs].
159 ## Generating the documentation
161 see [Sphinx Quickstart Template](SphinxQuickstartTemplate.html#generating-the-documentation)
|
| /openbsd-src/gnu/llvm/lldb/docs/ |
| H A D | conf.py | 3 # LLDB documentation build configuration file, created by
21 # we can generate documentation for its API.
25 # documentation root, use os.path.abspath to make it absolute, like shown here.
34 # Put the generated Python API documentation in the 'python_api' folder. This
40 # If your documentation needs a minimal Sphinx version, state it here.
52 # the Python API documentation.
85 # The language for content autogenerated by Sphinx. Refer to documentation
98 # Ignore the generated Python documentation that is only used on the website.
128 # The theme to use for HTML and HTML Help pages. See the documentation for
134 # documentation.
[all …]
|
| H A D | doxygen.cfg.in | 3 # This file describes the settings to be used by the documentation system
31 # This could be handy for archiving the generated documentation or
37 # base path where the generated documentation will be put.
53 # documentation generated by doxygen is written. Doxygen will use this
67 # the file and class documentation (similar to JavaDoc).
98 # inherited members of a class in the documentation of that class as if those
120 # the path mentioned in the documentation of a class, which tells
159 # member inherits the documentation from any documented member that it
165 # a new page for each member. If set to NO, the documentation of a member will
176 # as commands in the documentation. An alias has the form "name=value".
[all …]
|
| /openbsd-src/gnu/usr.bin/texinfo/ |
| H A D | INTRODUCTION | 16 "Texinfo" is a documentation system that uses a single source file to
23 The name of the Texinfo source documentation file is `texinfo.txi'.
25 source file. The documentation describes Texinfo in detail, including
33 To learn how to use Info, read the info documentation. You can do this in
44 After learning how to use Info, you can read the Texinfo documentation.
52 documentation.
54 The Texinfo documentation describes Texinfo in detail; among other things,
80 (See `How to Obtain TeX' in the Texinfo documentation.)
|
| /openbsd-src/gnu/llvm/libcxx/docs/ |
| H A D | README.txt | 1 libc++ Documentation
4 The libc++ documentation is written using the Sphinx documentation generator. It is
15 The documentation in this directory is published at https://libcxx.llvm.org. It is kept up-to-date
17 documentation is not updating anymore, please contact one of the maintainers.
|
| /openbsd-src/gnu/usr.bin/perl/cpan/podlators/docs/ |
| H A D | docknot.yaml | 4 # documentation files (like README.md) and web pages. Other documentation
6 # the release process. For more information, see DocKnot's documentation.
73 title: pod2man documentation
75 title: pod2text documentation
87 POD is the Plain Old Documentation format, the documentation language used
88 for all of Perl's documentation. I learned it to document Perl modules,
90 convenient way I've found to write program documentation. It's extremely
|
| /openbsd-src/gnu/llvm/clang/docs/ |
| H A D | doxygen.cfg.in | 3 # This file describes the settings to be used by the documentation system
31 # project for which the documentation is generated. This name is used in the
38 # could be handy for archiving the generated documentation or if some version
50 # the documentation. The maximum height of the logo should not exceed 55 pixels
57 # into which the generated documentation will be written. If a relative path is
74 # documentation generated by doxygen is written. Doxygen will use this
90 # documentation (similar to Javadoc). Set to NO to disable this.
123 # inherited members of a class in the documentation of that class as if those
150 # path mentioned in the documentation of a class, which tells the reader which
195 # documentation from any documented member that it re-implements.
[all …]
|
| /openbsd-src/share/man/man0/ |
| H A D | COPYRIGHT | 5 All of the documentation and software included in the 4.4BSD and 4.4BSD-Lite
18 documentation and/or other materials provided with the distribution.
37 given us permission to reprint portions of their documentation.
40 of the system documentation.
51 of the system documentation.
59 The views and conclusions contained in the software and documentation are
|