Skip to content

Commit

Permalink
Fixed many issues with the generated documentation and fix in Joystic…
Browse files Browse the repository at this point in the history 
…k API

API fix:
- Added named numbers in `Sf.Window.Joystick` as in original (anon enum was
  ignored)

Documentation fixes:
- Inline comments for fields and values where displaced by
  `gcc -fdump-ada-spec` and the output was broken; fixed with inline, post
  comment or @field
- Brief texts with indentation was detected as preformat by gnatdoc;
  Indentation removed
- Table in `Sf.Window.Cursor` is not supported by gnatdoc; changed to
  preformat
  • Loading branch information
@mgrojo
mgrojo committed Aug 22, 2023
1 parent a5598b9 commit f0f70e6
Show file tree
Hide file tree
Showing 110 changed files with 15,006 additions and 14,984 deletions.
102 changes: 67 additions & 35 deletions doc/docs/sf__audio__music___spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ GNATdoc.Documentation = {
{
"label": "sfTimeSpan",
"qualifier": "",
"line": 38,
"line": 36,
"column": 9,
"src": "srcs/sf-audio-music.ads.html",
"summary": [
Expand All @@ -22,7 +22,7 @@ GNATdoc.Documentation = {
"children": [
{
"kind": "line",
"number": 38,
"number": 36,
"children": [
{
"kind": "span",
Expand All @@ -43,7 +43,7 @@ GNATdoc.Documentation = {
"kind": "span",
"cssClass": "identifier",
"text": "sfTimeSpan",
"href": "docs/sf__audio__music___spec.html#L38C9"
"href": "docs/sf__audio__music___spec.html#L36C9"
},
{
"kind": "span",
Expand All @@ -69,7 +69,7 @@ GNATdoc.Documentation = {
},
{
"kind": "line",
"number": 39,
"number": 37,
"children": [
{
"kind": "span",
Expand All @@ -80,7 +80,7 @@ GNATdoc.Documentation = {
"kind": "span",
"cssClass": "identifier",
"text": "offset",
"href": "docs/sf__audio__music___spec.html#L39C7"
"href": "docs/sf__audio__music___spec.html#L37C7"
},
{
"kind": "span",
Expand Down Expand Up @@ -122,7 +122,23 @@ GNATdoc.Documentation = {
},
{
"kind": "line",
"number": 40,
"number": 38,
"children": [
{
"kind": "span",
"cssClass": "text",
"text": " "
},
{
"kind": "span",
"cssClass": "comment",
"text": "--/< The beginning offset of the time range"
}
]
},
{
"kind": "line",
"number": 39,
"children": [
{
"kind": "span",
Expand All @@ -133,7 +149,7 @@ GNATdoc.Documentation = {
"kind": "span",
"cssClass": "identifier",
"text": "length",
"href": "docs/sf__audio__music___spec.html#L40C7"
"href": "docs/sf__audio__music___spec.html#L39C7"
},
{
"kind": "span",
Expand Down Expand Up @@ -173,6 +189,22 @@ GNATdoc.Documentation = {
}
]
},
{
"kind": "line",
"number": 40,
"children": [
{
"kind": "span",
"cssClass": "text",
"text": " "
},
{
"kind": "span",
"cssClass": "comment",
"text": "--/< The length of the time range"
}
]
},
{
"kind": "line",
"number": 41,
Expand Down Expand Up @@ -201,7 +233,7 @@ GNATdoc.Documentation = {
"kind": "span",
"cssClass": "identifier",
"text": ";",
"href": "docs/sf__audio__music___spec.html#L38C9"
"href": "docs/sf__audio__music___spec.html#L36C9"
}
]
}
Expand All @@ -219,39 +251,49 @@ GNATdoc.Documentation = {
{
"kind": "span",
"text": " Structure defining a time range\n"
},
{
"kind": "span",
"text": "The beginning offset of the time range\n"
},
{
"kind": "span",
"text": "The length of the time range\n"
}
]
}
],
"fields": [
{
"label": "offset",
"line": 39,
"line": 37,
"column": 7,
"type": {
"label": "Sf.System.Time.sfTime",
"docHref": "docs/sf__system__time___spec.html#L28C9"
},
"description": [
{
"kind": "paragraph",
"children": [
{
"kind": "span",
"text": "The beginning offset of the time range\n"
}
]
}
]
},
{
"label": "length",
"line": 40,
"line": 39,
"column": 7,
"type": {
"label": "Sf.System.Time.sfTime",
"docHref": "docs/sf__system__time___spec.html#L28C9"
},
"description": [
{
"kind": "paragraph",
"children": [
{
"kind": "span",
"text": "The length of the time range\n"
}
]
}
]
}
]
Expand Down Expand Up @@ -758,7 +800,7 @@ GNATdoc.Documentation = {
"kind": "span",
"cssClass": "identifier",
"text": "Sf.System.InputStream.sfInputStream",
"href": "docs/sf__system__inputstream___spec.html#L50C9"
"href": "docs/sf__system__inputstream___spec.html#L45C9"
},
{
"kind": "span",
Expand Down Expand Up @@ -1744,7 +1786,7 @@ GNATdoc.Documentation = {
"kind": "span",
"cssClass": "identifier",
"text": "sfTimeSpan",
"href": "docs/sf__audio__music___spec.html#L38C9"
"href": "docs/sf__audio__music___spec.html#L36C9"
},
{
"kind": "span",
Expand Down Expand Up @@ -3091,20 +3133,10 @@ GNATdoc.Documentation = {
{
"kind": "span",
"text": " Tell whether a music's position is relative to the\n"
}
]
},
{
"kind": "code",
"children": [
},
{
"number": 1,
"children": [
{
"kind": "span",
"text": "listener or is absolute"
}
]
"kind": "span",
"text": "listener or is absolute\n"
}
]
}
Expand Down Expand Up @@ -3950,7 +3982,7 @@ GNATdoc.Documentation = {
"kind": "span",
"cssClass": "identifier",
"text": "sfTimeSpan",
"href": "docs/sf__audio__music___spec.html#L38C9"
"href": "docs/sf__audio__music___spec.html#L36C9"
},
{
"kind": "span",
Expand Down Expand Up @@ -4046,7 +4078,7 @@ GNATdoc.Documentation = {
"column": 50,
"type": {
"label": "Sf.Audio.Music.sfTimeSpan",
"docHref": "docs/sf__audio__music___spec.html#L38C9"
"docHref": "docs/sf__audio__music___spec.html#L36C9"
},
"description": [
{
Expand Down
16 changes: 3 additions & 13 deletions doc/docs/sf__audio__sound___spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1965,20 +1965,10 @@ GNATdoc.Documentation = {
{
"kind": "span",
"text": " Tell whether a sound's position is relative to the\n"
}
]
},
{
"kind": "code",
"children": [
},
{
"number": 1,
"children": [
{
"kind": "span",
"text": "listener or is absolute"
}
]
"kind": "span",
"text": "listener or is absolute\n"
}
]
}
Expand Down
2 changes: 1 addition & 1 deletion doc/docs/sf__audio__soundbuffer___spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1029,7 +1029,7 @@ GNATdoc.Documentation = {
"kind": "span",
"cssClass": "identifier",
"text": "Sf.System.InputStream.sfInputStream",
"href": "docs/sf__system__inputstream___spec.html#L50C9"
"href": "docs/sf__system__inputstream___spec.html#L45C9"
},
{
"kind": "span",
Expand Down
6 changes: 3 additions & 3 deletions doc/docs/sf__audio__soundbufferrecorder___spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -842,13 +842,13 @@ GNATdoc.Documentation = {
{
"kind": "span",
"cssClass": "text",
"text": " "
"text": " "
},
{
"kind": "span",
"cssClass": "identifier",
"text": "name",
"href": "docs/sf__audio__soundbufferrecorder___spec.html#L108C46"
"href": "docs/sf__audio__soundbufferrecorder___spec.html#L108C24"
},
{
"kind": "span",
Expand Down Expand Up @@ -961,7 +961,7 @@ GNATdoc.Documentation = {
{
"label": "name",
"line": 108,
"column": 46,
"column": 24,
"type": {
"label": "String"
},
Expand Down
16 changes: 3 additions & 13 deletions doc/docs/sf__audio__soundstream___spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2846,20 +2846,10 @@ GNATdoc.Documentation = {
{
"kind": "span",
"text": " Tell whether a sound stream's position is relative to the\n"
}
]
},
{
"kind": "code",
"children": [
},
{
"number": 1,
"children": [
{
"kind": "span",
"text": "listener or is absolute"
}
]
"kind": "span",
"text": "listener or is absolute\n"
}
]
}
Expand Down
Loading

0 comments on commit f0f70e6

Please sign in to comment.