Open Bug 458443 Opened 11 years ago Updated 2 years ago

[silme] Prepare documentation for Silme

Categories

(Localization Infrastructure and Tools :: Silme, defect)

x86
macOS
defect
Not set

Tracking

(Not tracked)

ASSIGNED

People

(Reporter: zbraniecki, Assigned: zbraniecki)

References

()

Details

No description provided.
working on that now
Status: NEW → ASSIGNED
Blocks: 478225
Now that we've released 0.5.1, is there any chance we can get some kind of docs for it on-line? What doxygen gives would be sufficient, just make the class hierarchy tree look right.
What we have right now is:

http://people.mozilla.org/~zbraniecki/silme/docs/
http://wiki.braniecki.net/Silme

I don't expect to have time to prettify doxygen output before 0.7
(In reply to comment #3)
> What we have right now is:
> http://people.mozilla.org/~zbraniecki/silme/docs/

This is hardly usable with the current class hierarchy that it offers. Fixing this would be a great step forward bringing us closer to fixing this bug and making it easier to get started with silme (the tutorial at wiki.braniecki.net does a good job of introducing Silme, we just need the API docs now).

> I don't expect to have time to prettify doxygen output before 0.7

I assume that by "prettify" you mean "fix class hierarchy"? I'd like to suggest raising priority of this bug. I'll be happy to help as much as I can.
I am wondering what we can do to get good documentation ready for the 0.7 release.  I have offered to help with this in some capacity.  But, until we have some documentation for the Silme API, I am not sure how many community members will join the cause by either contributing to Silme hacking or using it for tools.  To me, this is a high priority bug.

Also adding Pike since he is a Silme contributor.
> I assume that by "prettify" you mean "fix class hierarchy"? I'd like to suggest
raising priority of this bug. I'll be happy to help as much as I can.

> To me, this is a high priority bug.

I'd be happy to see doxygen conf (or in-code comment structure) improvements that would make doxygen output better (yes, including class hierarchy). I'm also open for other alternatives to doxygen if you know them.
It's just that at the moment I'm swamped with low level structure code for 0.7 and will not be able to play with documentation.

Stas: feel free to play with improvements in this area. I know you have a good sense of what should be there, and I totally second this. I just cannot skip to that phase now.
As a tip: The good news is that in most cases it should be a matter of one comment on top of each file declaring specific values for doxygen to read and doxygen to use specific code style reading to use those.
Moving Silme bugs to its component.

[Mass change filter: silme-move]
Component: Infrastructure → Silme
Product: Mozilla Localizations → Localization Infrastructure and Tools
You need to log in before you can comment on or make changes to this bug.