Questions tagged [documentation]
For questions related to the creation, usage, and improvement of software documentation
4 questions
1
vote
1
answer
324
views
C specification's "sequenced before" and "pair-wise relation"
Paragraph 5.2.2.4 of ISO 9899:2024 says
Sequenced before is an asymmetric, transitive, pair-wise relation between evaluations executed by a single thread...
What does the pair-wise relation mean? Is ...
- 133
0
votes
2
answers
188
views
Is it valid to call a configuration-format—with associated JSON-schema—a language?
Say I have a configuration file format that is very well defined; in say JSON format; with a JSON-schema defining what is allowed and how strict to be.
Would it be too generous to call this a Domain ...
- 103
5
votes
1
answer
109
views
Documenting the syntax of an existing language [closed]
I've inherited maintenance duties for a domain-specific language. This language started life forty years ago as a quick way to insert the results of mathematical operations into text documents, and ...
- 283
7
votes
4
answers
219
views
Enforcing doc comments in the compiler, good idea or not?
Most languages have a way of writing doc comments. Doc comments above a function, class, or struct provide a strucutred way to describe every part of the function, like this:
...
- 9,559