Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
C
clean-platform
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
17
Issues
17
List
Boards
Labels
Service Desk
Milestones
Merge Requests
3
Merge Requests
3
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
clean-and-itasks
clean-platform
Commits
703c14a4
Verified
Commit
703c14a4
authored
Oct 11, 2019
by
Camil Staps
🚀
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation about single-line documentation
parent
d2332fe0
Pipeline
#31151
passed with stage
in 3 minutes and 6 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
18 additions
and
2 deletions
+18
-2
doc/DOCUMENTATION.md
doc/DOCUMENTATION.md
+18
-2
No files found.
doc/DOCUMENTATION.md
View file @
703c14a4
...
...
@@ -23,8 +23,7 @@ map :: (a -> b) [a] -> [b]
For short documentation items, doclines, starting with
`//*`
can be used. When
documenting a constructor, or record field, they should be placed
*after*
the
item they document. Doclines are only supported for constructors and record
fields. For example:
item they document. For example:
```
clean
/**
...
...
@@ -37,6 +36,23 @@ fields. For example:
}
```
To add several lines of documentation to a constructor or record field, several
doclines can be used:
```
clean
::
MyType
=
MyConstructor
args
// ...
//* This constructor may require some more explanation,
//* which is added on several lines.
```
Doclines can also be added
*above*
a function, type, or class definition:
```
clean
//* The identity function.
id
::
.
a
->
.
a
```
## Markup in documentation
Some simple Markdown-inspired markup is allowed in documentation:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment