[elbrujohalcon]

Fixes #211

[Copilot]

Copilot review overview

🟡 Changes recommended

Several new API descriptions contain incorrect component names and a nonexistent callback reference.

Review effort: Balanced
Findings: 3

Open (3)

• Fix grammar before “single-valued” · New
• Use schemas or parameters as definition component keys · New
• Correct trails callback arity in documentation · New

What changed in this PR

Migrates project documentation to OTP 28’s native documentation format.

Changes:

• Adds -moduledoc and -doc attributes to public APIs and types.
• Groups documented APIs and hides private functions.
• Removes obsolete comment-based section headers.

File	Description
src/​cowboy_swagger.erl	Migrates API and type documentation.
src/​cowboy_swagger_handler.erl	Documents module and trails APIs.
src/​cowboy_swagger_json_handler.erl	Documents module and callback groups.
src/​cowboy_swagger_redirect_handler.erl	Marks internal module undocumented.
test/​cowboy_swagger_SUITE.erl	Replaces private annotations and removes headers.
test/​cowboy_swagger_handler_SUITE.erl	Modernizes private documentation.
test/​cowboy_swagger_server_spec_SUITE.erl	Modernizes a private annotation.
test/​multiple_hosts_servers_example.erl	Migrates application documentation.
test/​example.erl	Migrates application documentation.
test/​example_sup.erl	Removes obsolete section comments.
test/​example_echo_handler.erl	Removes obsolete section comments.
test/​example_description_handler.erl	Removes obsolete section comments.
test/​example_default.erl	Removes an obsolete section comment.
test/​host1_handler.erl	Removes obsolete section comments.
example/​src/​example.erl	Migrates example application documentation.
example/​src/​example_sup.erl	Removes obsolete section comments.
example/​src/​example_echo_handler.erl	Removes obsolete section comments.
example/​src/​example_description_handler.erl	Removes obsolete section comments.
example/​src/​example_default.erl	Removes an obsolete section comment.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.