Showing posts with label documentation. Show all posts
Showing posts with label documentation. Show all posts
Jun 17, 2008
Addressing Lines in Plain Text Files
Jirka suggested a possibility to enhance YCP documentation with real-life code examples. For that, we'd need to point to numbered lines within the source code. I thought that ViewVC can do it but apparently not (maybe annotate has it, but it is broken at our site). But there is a new generic way: RFC 5147: URI Fragment Identifiers for the text/plain Media Type. Only none of the browsers seems to support it today...
This points to line 13, with the prototype of main:
This points to line 13, with the prototype of main:
http://svn.opensuse.org/svn/yast/trunk/libyui/examples/HelloWorld.cc#line=,13
Jun 11, 2008
Medoosa in OBS
Medoosa is a documentation tool for C++ that can produce UML class diagrams including generalizations and associations. Corrections can be made interactively in a diagram editor (Dia) and are fed back into the source as Javadoc-style comments. At this time, the layout must still be done by hand. Some code is already present to produce the layout with Graphviz.
I wrote it for my master's thesis at the Charles University back in 2001 and it has been since then quietly sitting at SourceForge. Today I have rebuilt it in the openSUSE Build Service: Medoosa, CcDoc-0.7a (required).
I wrote it for my master's thesis at the Charles University back in 2001 and it has been since then quietly sitting at SourceForge. Today I have rebuilt it in the openSUSE Build Service: Medoosa, CcDoc-0.7a (required).
Labels:
Build Service,
C++,
CcDoc,
Dia,
diagram,
documentation,
Javadoc,
Medoosa,
thesis,
UML
Subscribe to:
Posts (Atom)