I checked the current nim jsondoc output and it seems there is some terminology
difference, because for
type
Enum* = enum
value1
value2
value3 ## Some value
Object* = object
field1: int ## Documentation
field2*: Enum
proc returnX*(): Enum =
## Documentat
runnableExamples:
echo 12
value3
Run
it gives
{
"orig": "/tmp/a.nim",
"nimble": "unknown",
"moduleDescription": "",
"entries": [
{
"name": "Enum",
"type": "skType",
"line": 2,
"col": 8,
"code": "Enum = enum\n value1, value2, value3 ## Some value"
},
{
"name": "Object",
"type": "skType",
"line": 7,
"col": 10,
"code": "Object = object\n ## Documentation\n field2*: Enum\n"
},
{
"name": "returnX",
"type": "skProc",
"line": 12,
"col": 0,
"code": "proc returnX(): Enum {.raises: [], tags: [], forbids: [].}",
"signature": {
"return": "Enum",
"pragmas": [
"raises: []",
"tags: []",
"forbids: []"
]
},
"description": "Documentat"
}
]
}
Run
Which I will describe as "there is some plaintext code copypaste from your
file, figure out the rest yourself". For example, if I want to have a
documentation for enums formatted as a table -- good luck.
