| View previous topic :: View next topic |
| Author |
Message |
bioinfornatics
Joined: 22 Jun 2010
Posts: 90
|
 Posted: Fri Dec 09, 2011 11:27 am Post subject: documentation |
 |
|
they are a problem how doc is formatting !
current:
| Code: | /*
** A documentation info
*/ |
should be:
| Code: | /**
*A documentation info
*/ |
thanks for this litlle bug sed could be usefull
How fix :
| Code: | find /usr/include/d/derelict/ -name "*.di" | xargs sed -i 's/\\x0a/\n/'g
find /usr/include/d/derelict/ -name "*.di" | xargs sed -i '$!N;s|/\*\s*\n\(\s*\)\*\*|/**\n\1*|g'
find /usr/include/d/derelict/ -name "*.di" | xargs sed -i '$!N;s|/\*\s*\n\(\s*\)\*\*|/**\n\1*|g' |
note is src file they are some extra character \x0a these commands fix all |
|
| Back to top |
|
 |
aldacron
Joined: 05 May 2004
Posts: 1322
Location: Seoul, South Korea
|
|
| Back to top |
|
|
bioinfornatics
Joined: 22 Jun 2010
Posts: 90
|
| Posted: Mon Dec 12, 2011 9:28 pm Post subject: |
|
|
by example: derelictGL/derelict/opengl/cgl.d
it will be great too a d doc for each method. Maybe i can try to help you for this |
|
| Back to top |
|
|
aldacron
Joined: 05 May 2004
Posts: 1322
Location: Seoul, South Korea
|
| Posted: Tue Dec 13, 2011 4:19 am Post subject: |
|
|
OK, as far as I know that's the only module with DDoc comments. And I'll say, for the record, I don't think any DDoc comments belong in Derelict. But They just aren't needed. All of the APIs Derelict binds to are already documented elsewhere. The only argument I can see for DDoc comments would be for DerelictUtil, but that's what the existing documentation is for.
So, please, no DDoc comments in Derelict.
_________________
The One With D | The One With Aldacron | D Bits |
|
| Back to top |
|
|
bioinfornatics
Joined: 22 Jun 2010
Posts: 90
|
| Posted: Tue Dec 13, 2011 11:37 am Post subject: |
|
|
| OK, the reason it was for create a devhelp books |
|
| Back to top |
|
|
|
FAQ
Search
Memberlist
Usergroups
Register
Profile
Log in to check your private messages
Log in
