Home
last modified time | relevance | path

Searched full:documentation (Results 1 – 25 of 10814) sorted by relevance

12345678910>>...433

/third_party/rust/rust/src/tools/rust-analyzer/crates/ide/src/syntax_highlighting/test_data/
Dhighlight_doctest.html9 .documentation { color: #629755; }
45 <pre><code><span class="comment documentation">//! This is a module to test doc injection.</span>
46 <span class="comment documentation">//! ```</span>
47 <span class="comment documentation">//!</span><span class="comment documentation"> </span><span cla…
48 <span class="comment documentation">//! ```</span>
52 <span class="comment documentation">/// ```</span>
53 <span class="comment documentation">///</span><span class="comment documentation"> </span><span cla…
54 <span class="comment documentation">/// ```</span>
59documentation">/// This is an impl of </span><span class="struct documentation injected intra_doc_…
60 <span class="comment documentation">///</span>
[all …]
/third_party/typescript/tests/baselines/reference/
DjsdocDisallowedInTypescript.errors.txt1 …wedInTypescript.ts(2,15): error TS8020: JSDoc types can only be used inside documentation comments.
2 …wedInTypescript.ts(4,15): error TS8020: JSDoc types can only be used inside documentation comments.
3 …wedInTypescript.ts(4,32): error TS8020: JSDoc types can only be used inside documentation comments.
4 …wedInTypescript.ts(7,20): error TS8020: JSDoc types can only be used inside documentation comments.
5 …edInTypescript.ts(10,18): error TS8020: JSDoc types can only be used inside documentation comments.
7 …edInTypescript.ts(13,14): error TS8020: JSDoc types can only be used inside documentation comments.
8 …edInTypescript.ts(14,11): error TS8020: JSDoc types can only be used inside documentation comments.
9 …wedInTypescript.ts(15,8): error TS8020: JSDoc types can only be used inside documentation comments.
10 …edInTypescript.ts(16,11): error TS8020: JSDoc types can only be used inside documentation comments.
11 …edInTypescript.ts(17,17): error TS8020: JSDoc types can only be used inside documentation comments.
[all …]
DsignatureHelpTypeArguments2.baseline125 "documentation": [
127 "text": "some documentation 2",
142 "documentation": [
159 "documentation": [
176 "documentation": [],
187 "documentation": [
189 "text": "some documentation",
206 "text": "some documentation 2",
418 "documentation": [
420 "text": "some documentation 2",
[all …]
/third_party/rust/rust/tests/ui/rfcs/rfc-2565-param-attrs/
Dparam-attrs-builtin-attrs.rs4 //~^ ERROR documentation comments cannot be applied to function in ffi()
8 //~^ ERROR documentation comments cannot be applied to function in ffi()
12 //~^ ERROR documentation comments cannot be applied to function in ffi()
20 //~^ ERROR documentation comments cannot be applied to function
24 //~^ ERROR documentation comments cannot be applied to function
28 //~^ ERROR documentation comments cannot be applied to function
35 //~^ ERROR documentation comments cannot be applied to function in foo()
39 //~^ ERROR documentation comments cannot be applied to function in foo()
43 //~^ ERROR documentation comments cannot be applied to function in foo()
52 //~^ ERROR documentation comments cannot be applied to function in foo()
[all …]
Dparam-attrs-builtin-attrs.stderr61 error: documentation comments cannot be applied to function parameters
67 error: documentation comments cannot be applied to function parameters
79 error: documentation comments cannot be applied to function parameters
91 error: documentation comments cannot be applied to function parameters
97 error: documentation comments cannot be applied to function parameters
109 error: documentation comments cannot be applied to function parameters
121 error: documentation comments cannot be applied to function parameters
127 error: documentation comments cannot be applied to function parameters
139 error: documentation comments cannot be applied to function parameters
151 error: documentation comments cannot be applied to function parameters
[all …]
/third_party/mesa3d/src/freedreno/registers/
Drules-fd.xsd8 <documentation>
15 </documentation>
16 <documentation>Version 0.1</documentation>
40 <!-- Documentation elements -->
58 <documentation>
60 </documentation>
71 <documentation>nickType</documentation>
80 <documentation>databaseType</documentation>
90 <documentation>importType</documentation>
97 <documentation>copyrightType</documentation>
[all …]
/third_party/rust/rust/tests/ui/lint/
Dlint-missing-doc.rs16 pub type PubTypedef = String; //~ ERROR: missing documentation for a type alias
23 pub struct PubFoo { //~ ERROR: missing documentation for a struct
24 pub a: isize, //~ ERROR: missing documentation for a struct field
35 pub mod pub_module_no_dox {} //~ ERROR: missing documentation for a module
39 pub fn foo2() {} //~ ERROR: missing documentation for a function in foo2()
57 pub trait C { //~ ERROR: missing documentation for a trait
58 fn foo(&self); //~ ERROR: missing documentation for a method in foo()
59 fn foo_with_impl(&self) {} //~ ERROR: missing documentation for a method in foo_with_impl()
60 fn foo_no_self(); //~ ERROR: missing documentation for an associated function in foo_no_self()
61 fn foo_no_self_with_impl() {} //~ ERROR: missing documentation for an associated function in foo_no_self_with_impl()
[all …]
Dlint-missing-doc.stderr1 error: missing documentation for a type alias
13 error: missing documentation for a struct
19 error: missing documentation for a struct field
25 error: missing documentation for a module
31 error: missing documentation for a function
37 error: missing documentation for a trait
43 error: missing documentation for a method
49 error: missing documentation for a method
55 error: missing documentation for an associated function
61 error: missing documentation for an associated function
[all …]
/third_party/skia/m133/third_party/externals/dng_sdk/
DLICENSE.source_code3 Adobe Systems Incorporated provides the Software and Documentation for use under
5 modification or distribution of the Software or Documentation, or any
10 accompanying this Agreement. "Documentation" means the documents, specifications
21 copies of the Documentation for your development purposes and to publicly
23 Documentation.
27 Documentation and you will include such notices in any copies of the Software
31 Documentation in any manner not permitted by this Agreement. No title to the
32 intellectual property in the Software or Documentation is transferred to you
34 or the Documentation except as expressly set forth in this Agreement. All rights
38 ADOBE PROVIDES THE SOFTWARE AND DOCUMENTATION ONLY ON AN "AS IS" BASIS WITHOUT
[all …]
DLICENSE6 Adobe Systems Incorporated provides the Software and Documentation for use under
8 modification or distribution of the Software or Documentation, or any
13 accompanying this Agreement. "Documentation" means the documents, specifications
24 copies of the Documentation for your development purposes and to publicly
26 Documentation.
30 Documentation and you will include such notices in any copies of the Software
34 Documentation in any manner not permitted by this Agreement. No title to the
35 intellectual property in the Software or Documentation is transferred to you
37 or the Documentation except as expressly set forth in this Agreement. All rights
41 ADOBE PROVIDES THE SOFTWARE AND DOCUMENTATION ONLY ON AN "AS IS" BASIS WITHOUT
[all …]
DNOTICE13 Adobe Systems Incorporated provides the Software and Documentation for use under
15 modification or distribution of the Software or Documentation, or any
20 accompanying this Agreement. "Documentation" means the documents, specifications
31 copies of the Documentation for your development purposes and to publicly
33 Documentation.
37 Documentation and you will include such notices in any copies of the Software
41 Documentation in any manner not permitted by this Agreement. No title to the
42 intellectual property in the Software or Documentation is transferred to you
44 or the Documentation except as expressly set forth in this Agreement. All rights
48 ADOBE PROVIDES THE SOFTWARE AND DOCUMENTATION ONLY ON AN "AS IS" BASIS WITHOUT
[all …]
/third_party/skia/third_party/externals/dng_sdk/
DLICENSE6 Adobe Systems Incorporated provides the Software and Documentation for use under
8 modification or distribution of the Software or Documentation, or any
13 accompanying this Agreement. "Documentation" means the documents, specifications
24 copies of the Documentation for your development purposes and to publicly
26 Documentation.
30 Documentation and you will include such notices in any copies of the Software
34 Documentation in any manner not permitted by this Agreement. No title to the
35 intellectual property in the Software or Documentation is transferred to you
37 or the Documentation except as expressly set forth in this Agreement. All rights
41 ADOBE PROVIDES THE SOFTWARE AND DOCUMENTATION ONLY ON AN "AS IS" BASIS WITHOUT
[all …]
DLICENSE.source_code3 Adobe Systems Incorporated provides the Software and Documentation for use under
5 modification or distribution of the Software or Documentation, or any
10 accompanying this Agreement. "Documentation" means the documents, specifications
21 copies of the Documentation for your development purposes and to publicly
23 Documentation.
27 Documentation and you will include such notices in any copies of the Software
31 Documentation in any manner not permitted by this Agreement. No title to the
32 intellectual property in the Software or Documentation is transferred to you
34 or the Documentation except as expressly set forth in this Agreement. All rights
38 ADOBE PROVIDES THE SOFTWARE AND DOCUMENTATION ONLY ON AN "AS IS" BASIS WITHOUT
[all …]
DNOTICE13 Adobe Systems Incorporated provides the Software and Documentation for use under
15 modification or distribution of the Software or Documentation, or any
20 accompanying this Agreement. "Documentation" means the documents, specifications
31 copies of the Documentation for your development purposes and to publicly
33 Documentation.
37 Documentation and you will include such notices in any copies of the Software
41 Documentation in any manner not permitted by this Agreement. No title to the
42 intellectual property in the Software or Documentation is transferred to you
44 or the Documentation except as expressly set forth in this Agreement. All rights
48 ADOBE PROVIDES THE SOFTWARE AND DOCUMENTATION ONLY ON AN "AS IS" BASIS WITHOUT
[all …]
/third_party/python/Doc/library/
Dpydoc.rst1 :mod:`pydoc` --- Documentation generator and online help system
5 :synopsis: Documentation generator and online help system.
13 single: documentation; generation
14 single: documentation; online
19 The :mod:`pydoc` module automatically generates documentation from Python
20 modules. The documentation can be presented as pages of text on the console,
23 For modules, classes, functions and methods, the displayed documentation is
31 interactive interpreter, which uses :mod:`pydoc` to generate its documentation
32 as text on the console. The same text documentation can also be viewed from
38 at a shell prompt will display documentation on the :mod:`sys` module, in a
[all …]
/third_party/rust/rust/src/doc/rustdoc/src/
DSUMMARY.md6 - [In-doc settings](read-documentation/in-doc-settings.md)
7 - [How to write documentation](how-to-write-documentation.md)
8 - [What to include (and exclude)](write-documentation/what-to-include.md)
9 - [The `#[doc]` attribute](write-documentation/the-doc-attribute.md)
10 - [Re-exports](write-documentation/re-exports.md)
11 - [Linking to items by name](write-documentation/linking-to-items-by-name.md)
12 - [Documentation tests](write-documentation/documentation-tests.md)
Dhow-to-read-rustdoc.md6 and is a great starting point for documentation authors and users alike.
14 and the documentation for the current item below that.
16 ## The Item Documentation
18 The majority of the screen is taken up with the documentation text for the item
26 - a button to collapse or expand the top-level documentation for that item
29 if [configured](write-documentation/the-doc-attribute.html#html_no_source),
31 the documentation was created with `cargo doc --no-deps`),
35 Below this is the main documentation for the item,
43 Subheadings, variants, fields, and many other things in this documentation
51 For example, when looking at documentation for the crate root,
[all …]
Dcommand-line-arguments.md161 When rustdoc generates documentation, looks for documentation tests, or executes documentation
164 these options won't affect a regular documentation run, but if something depends on target features
165 to be enabled, or documentation tests need to use some additional options, this flag allows you to
180 on documentation tests](write-documentation/documentation-tests.md).
192 This flag will pass options to the test runner when running documentation tests.
193 For more, see [the chapter on documentation tests](write-documentation/documentation-tests.md).
206 For more, see [the chapter on documentation tests](write-documentation/documentation-tests.md).
210 ## `--target`: generate documentation for the specified target triple
218 Similar to the `--target` flag for `rustc`, this generates documentation
272 the rendered documentation.
[all …]
Dhow-to-write-documentation.md1 # How to write documentation
3 Good documentation is not natural. There are opposing goals that make writing
4 good documentation difficult. It requires expertise in the subject but also
5 writing to a novice perspective. Documentation therefore often glazes over
8 There are a few tenets to Rust documentation that can help guide anyone through
12 This chapter covers not only how to write documentation but specifically
13 how to write **good** documentation. It is important to be as clear
15 documentation you write for your crate the better. If an item is public
20 Documenting a crate should begin with front-page documentation. As an
21 example, the [`hashbrown`] crate level documentation summarizes the role of
[all …]
/third_party/json/docs/mkdocs/docs/features/
Dmacros.md4 See also the [API documentation for macros](../api/macros/index.md) for examples and more informati…
10 See [full documentation of `JSON_ASSERT(x)`](../api/macros/json_assert.md).
16 See [full documentation of `JSON_CATCH_USER(exception)`](../api/macros/json_throw_user.md).
30 See [full documentation of `JSON_DIAGNOSTICS`](../api/macros/json_diagnostics.md).
40 See [full documentation of `JSON_HAS_CPP_11`, `JSON_HAS_CPP_14`, `JSON_HAS_CPP_17`, and `JSON_HAS_C…
49 See [full documentation of `JSON_HAS_FILESYSTEM` and `JSON_HAS_EXPERIMENTAL_FILESYSTEM`](../api/mac…
55 See [full documentation of `JSON_NOEXCEPTION`](../api/macros/json_noexception.md).
61 See [full documentation of `JSON_DISABLE_ENUM_SERIALIZATION`](../api/macros/json_disable_enum_seria…
69 See [full documentation of `JSON_NO_IO`](../api/macros/json_no_io.md).
76 See [full documentation of `JSON_SKIP_LIBRARY_VERSION_CHECK`](../api/macros/json_skip_library_versi…
[all …]
/third_party/rust/rust/src/tools/clippy/tests/ui/
Dmissing_doc.stderr1 error: missing documentation for a type alias
9 error: missing documentation for a module
15 error: missing documentation for a function
21 error: missing documentation for an enum
30 error: missing documentation for a variant
36 error: missing documentation for a struct field
42 error: missing documentation for a struct field
48 error: missing documentation for a variant
54 error: missing documentation for a constant
60 error: missing documentation for a static
[all …]
/third_party/rust/rust/src/tools/clippy/tests/ui/doc/
Ddoc-fixable.stderr1 error: item in documentation is missing backticks
13 error: item in documentation is missing backticks
24 error: item in documentation is missing backticks
35 error: item in documentation is missing backticks
46 error: item in documentation is missing backticks
57 error: item in documentation is missing backticks
68 error: item in documentation is missing backticks
79 error: item in documentation is missing backticks
90 error: item in documentation is missing backticks
101 error: item in documentation is missing backticks
[all …]
/third_party/typescript/tests/cases/fourslash/
DcommentsExternalModulesFourslash.ts40 { name: "b", text: "var b: number", documentation: "b's comment" },
41 { name: "foo", text: "function foo(): number", documentation: "foo's comment" },
50 includes: { name: "m1", text: "namespace m1", documentation: "Namespace comment" },
56 { name: "b", text: "var m1.b: number", documentation: "b's comment" },
57 …{ name: "fooExport", text: "function m1.fooExport(): number", documentation: "exported function" },
58 { name: "m2", text: "namespace m1.m2", documentation: "m2 comments" },
70 { name: "c", text: "constructor m1.m2.c(): m1.m2.c", documentation: "class comment;" },
71 { name: "i", text: "var m1.m2.i: m1.m2.c", documentation: "i" },
81 …, text: 'import extMod = require("./commentsExternalModules_file0")', documentation: "This is on i…
85 includes: { name: "m1", text: "namespace extMod.m1", documentation: "Namespace comment" },
[all …]
DjsDocInheritDoc.ts5 //// * Foo constructor documentation
9 //// * Foo#method1 documentation
13 //// * Foo#method2 documentation
17 //// * Foo#property1 documentation
21 //// * Foo#property3 documentation
26 //// /** Baz#property1 documentation */
29 //// * Baz#property2 documentation
60 verify.quickInfoAt("2", "(method) Bar.method2(): void", "Foo#method2 documentation"); // use inheri…
61 verify.quickInfoAt("3", "(method) Bar.method1(): void", 'Foo#method1 documentation'); // use inheri…
62 verify.quickInfoAt("4", "(property) Bar.property1: string", "Foo#property1 documentation"); // use …
[all …]
/third_party/json/docs/
DREADME.md1 # Documentation chapter
3 ## Generate documentation
5 Note on documentation: The source files contain links to the online documentation at https://json.n…
6 contains the most recent documentation and should also be applicable to previous versions; document…
9 If you want to see the documentation for a specific tag or commit hash, you can generate it as foll…
20 with `http://127.0.0.1:8000` to see the documentation for your tag or commit hash.

12345678910>>...433