File: api-reference-syntax.md

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (27 lines) | stat: -rw-r--r-- 809 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# API Documentation

Teach your APIs through reference documentation you create from code comments and extension files, or create detailed articles and conceptual guides.

## Overview

Use documentation markup, a custom variant of Markdown, to add in-source documentation to your APIs. Then, use DocC to build your documentation and share it with developers.

![A screenshot showing the rendered documentation for the SlothCreator framework, including the overview and a partially obscured image.](2_docs)

## Topics

### Configuring Documentation Behavior

- ``Options``
- ``Metadata``
- ``TechnologyRoot``
- ``Redirected``

### Creating Custom Page Layouts

- ``Row``
- ``TabNavigator``
- ``Links``
- ``Small``

<!-- Copyright (c) 2021-2023 Apple Inc and the Swift Project authors. All Rights Reserved. -->