Moved documentation to header files #57
Conversation
apfohl
commented
Oct 3, 2019
apfohl
commented
- Moved all function documentation to the corresponding header file
- Reordered functions in header files to match ordering in implementation files
- Added missing documentation
- Leave documentation stubs for missing documentation
- Moved all function documentation to the corresponding header file - Reordered functions in header files to match ordering in implementation files - Added missing documentation - Leave documentation stubs for missing documentation
|
This PR fixed #52. |
| /** | ||
| * ToDo: Check where this is coming from as it has no implementation | ||
| * @param seconds | ||
| */ | ||
| extern void cgi_session_set_max_idle_time(unsigned long seconds); |
There was a problem hiding this comment.
I discovered that this function prototype does not have a matching implementation. Is this still needed?
|
Are there any news on this one? Is this okay? Shall I change something? |
|
It's on my ToDo-List, will review it. |
There was a problem hiding this comment.
I tried to review your PR, but I find it hard. The commit message reads:
- Moved all function documentation to the corresponding header file
- Reordered functions in header files to match ordering in implementation files
- Added missing documentation
- Leave documentation stubs for missing documentation
If it's not too cumbersome for you, could you split all that in different commits like this?
- Whitespace changes in one separate commit
- Moving things from source to header in one separate commit (without changing content)
- Reordering in one separate commit
- Improving things in one or more separate commits
Please also use @todo or TODO.
I like the structuring using Doxygen defgroups. 😄
If this is too much work for you, drop me a note, I'll give it another try all in one then.
Don't be confuse about the annotations below, I started reviewing, but aborted. 👼
| * HTTP status codes. | ||
| * HTTP status codes. | ||
| * | ||
| * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html | ||
| * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html |
There was a problem hiding this comment.
Whitespace change only, right?
| * General purpose linked list. Actually isn't very portable because | ||
| * uses only 'name' and 'value' variables to store data. Probably, in | ||
| * a future release, this will be replaced by another type of struct. | ||
| * General purpose linked list. Actually isn't very portable because | ||
| * uses only 'name' and 'value' variables to store data. Probably, in | ||
| * a future release, this will be replaced by another type of struct. |
There was a problem hiding this comment.
This also looks like whitespace change only. Whitespace changes should go to separate commits.
|
|
||
| #define E_WARNING 0 | ||
| #define E_FATAL 1 | ||
| #define E_CAUTION 2 | ||
| #define E_INFORMATION 3 | ||
| #define E_MEMORY 4 | ||
|
|
||
| /** | ||
| * ToDo: Add documentation |
There was a problem hiding this comment.
Use @todo or TODO please.
|
Yes, of cause I can restructure this PR. Give me some time. |
