platforms/ide/ide-native/         @gradle/bt-ide-experience @gradle/bt-native-maintainers

# Documentation
platforms/documentation/docs/src/docs/                                                        @gradle/bt-devrel-education
platforms/documentation/docs/src/samples/                                                     @gradle/bt-devrel-education
platforms/documentation/docs/src/docs-asciidoctor-extensions-base/                            @gradle/bt-devrel-education

though we use GitHub-flavored Markdown for internal documentation too.

You can generate docs by running `./gradlew :docs:docs`.
This will build the whole documentation locally in [platforms/documentation](./platforms/documentation).
For more commands and examples, including local development,
see [this guide](./platforms/documentation/docs/README.md).

### Creating commits and writing commit messages

## Documentation automatique

Les schémas JSON de vos modèles seront intégrés au schéma OpenAPI global de votre application, et seront donc affichés dans la documentation interactive de l'API :

<img src="/img/tutorial/body/image01.png">

Et seront aussi utilisés dans chaque *opération de chemin* de la documentation utilisant ces modèles :

---

### 💬 **Community Support & Resources**

The Gradle community offers a range of forums, documentation, and direct help to guide you through every step of your Gradle journey:

- **Documentation**: The [Gradle User Manual](https://docs.gradle.org/current/userguide/userguide.html) covers everything from basic to advanced configurations.

                    throw new ExpressionDocumentationException(
                            "Failed to read documentation for expression root: " + root, e);
                } catch (XmlPullParserException e) {
                    throw new ExpressionDocumentationException(
                            "Failed to parse documentation for expression root: " + root, e);
                }
            }
        }

~~ under the License.

 -----
 Maven Logging
 -----
 Hervé Boutemy
 -----
 2013-08-02
 -----

Maven Logging

 {{{/maven-logging.html}End-user logging documentation}} is available {{{/maven-logging.html}in Maven site}}.
 This documentation is focused on internal implementation details.

* Logging API

 Maven uses

## About security, APIs, and docs

Hiding your documentation user interfaces in production *shouldn't* be the way to protect your API.

That doesn't add any extra security to your API, the *path operations* will still be available where they are.

If there's a security flaw in your code, it will still exist.

{* ../../docs_src/graphql/tutorial001.py hl[3,22,25:26] *}

You can learn more about Strawberry in the <a href="https://strawberry.rocks/" class="external-link" target="_blank">Strawberry documentation</a>.

And also the docs about <a href="https://strawberry.rocks/docs/integrations/fastapi" class="external-link" target="_blank">Strawberry with FastAPI</a>.

## Older `GraphQLApp` from Starlette

* Convert from and to JSON automatically.
* Document everything with OpenAPI, that can be used by:
    * Interactive documentation systems.
    * Automatic client code generation systems, for many languages.
* Provide 2 interactive documentation web interfaces directly.

---

We just scratched the surface, but you already get the idea of how it all works.

Try changing the line with:

import java.util.List;

import org.apache.commons.cli.Option;
import org.junit.jupiter.api.Test;

import static java.util.Objects.nonNull;

/**
 * Pseudo test to generate documentation fragment about supported CLI options. TODO such documentation generation code
 * should not be necessary as unit test but should be run during site generation (Velocity? Doxia macro?)
 */
class CLIManagerDocumentationTest {