Edoc suggestions

Vlad Dumitrescu <>
Fri Jun 3 11:05:39 CEST 2005


Hi,

After submitting the "first real edoc bug report in ages" (quoting Richard 
Carlsson) I also have some improvement suggestions. If it's already 
possible, it should at least be documented better.

It would be nice if the global 'private' option could be overriden at module 
and function level. I want only some modules to be processed in 'private' 
mode. Also, using private mode, one needs to add @hidden tags all over the 
place.

I'd like to suggest the following changes:
- @hidden works as it does now, unconditionally
- @private declares module/function as private, documentation should be 
generated
- @public declares module/function as public, documentation should be 
generated
- modify 'private' option's semantics so that
    private=false generates only public & not hidden modules/functions, 
disregarding tags
    private=true delegates to the module/function tags
- @private and @public at module level basically define the default value 
for the functions

This way no change is needed for generating truly public documentation, and 
for generating private documentation one can only tag those parts that are 
affected. It's not fun to go through files, adding @hidden tags... :-)

I'm not sure if this is a complete solution, but might be a basis for 
discussion.
best regards,
Vlad

_________________________________________________________________
Express yourself instantly with MSN Messenger! Download today it's FREE! 
http://messenger.msn.click-url.com/go/onm00200471ave/direct/01/




More information about the erlang-questions mailing list