July 11, 2009 Re: Descent generated documentation | ||||
---|---|---|---|---|
| ||||
Posted in reply to torhu |
torhu wrote:
> On 10.07.2009 14:41, Ary Borenszweig wrote:
>> You can select the maximum visibility: private, protected or public.
>>
>> (in the original UI in the plugin for Java there's also "package", but... where does "package" fall? private< package< protected? protected< package< public? I think neither, mmm...)
>
> I'd say the first order is right. package is 'private to the library', but protected is available in subclasses everywhere.
Actually, a better idea might be to insert Javascript to allow filtering visibility. Just calling a library? Default to showing only public members. Want to subclass something? Switch to show protected. Doing development on it? Switch to show package/all.
|
July 11, 2009 Re: Descent generated documentation | ||||
---|---|---|---|---|
| ||||
Posted in reply to Ary Borenszweig | Ary Borenszweig escribió: > Hi all! > > So... I've been playing around with generating ddocs from Descent. > > phobos: http://downloads.dsource.org/projects/descent/ddoc/phobos/ > Tango: http://downloads.dsource.org/projects/descent/ddoc/tango/ Who wants to drool? :) I updated the docs once more. *Now hierarchies are also shown for templated classes and interfaces*. See for example tango.util.collection.impl.Collection. I also show templated functions and templated types. I still don't show template parameters correctly, and in templated types you'll see a lot of voids and ints. Don't complain yet about that, I need to fix that. Also are missing all the suggestions other made... And I know a lot of other things are not working ok. You may now just complain about the esthetics or missing funcionality. :-P |
July 11, 2009 Re: Descent generated documentation | ||||
---|---|---|---|---|
| ||||
Posted in reply to Ary Borenszweig | *drools* Some more wishes: D2 support? Couple of minor suggestions for the aesthetics (this is a matter of taste too of course): - make the declarations stand out more, bold font or something. - all the non-comments stuff should be in a different, monospace font - parameters names in italic - name of the module as the title of the html page In general, I very much would love to see little javascript if at all, CSS for styling with use of div's (and CSS classes). This so that people could style it themselves easily (and contribute nice sheets?). Oh, is it possible to detect overloads? You could add links to them (like with the class hierarchy) or group them together. Could it be done across modules? Last detail: small message at the bottom saying it was generated with descent at date so and so. Right, I'll stop for now :) |
July 11, 2009 Re: Descent generated documentation | ||||
---|---|---|---|---|
| ||||
Posted in reply to Ary Borenszweig | On 7/11/09 7:05 PM, Ary Borenszweig wrote:
> Ary Borenszweig escribió:
>> Hi all!
>>
>> So... I've been playing around with generating ddocs from Descent.
>>
>> phobos: http://downloads.dsource.org/projects/descent/ddoc/phobos/
>> Tango: http://downloads.dsource.org/projects/descent/ddoc/tango/
>
> Who wants to drool? :)
>
> I updated the docs once more. *Now hierarchies are also shown for
> templated classes and interfaces*. See for example
> tango.util.collection.impl.Collection.
>
> I also show templated functions and templated types. I still don't show
> template parameters correctly, and in templated types you'll see a lot
> of voids and ints. Don't complain yet about that, I need to fix that.
>
> Also are missing all the suggestions other made...
>
> And I know a lot of other things are not working ok. You may now just
> complain about the esthetics or missing funcionality. :-P
Please add some spacing between things, a couple of newlines.
|
July 11, 2009 Re: Descent generated documentation | ||||
---|---|---|---|---|
| ||||
Posted in reply to Lutger | Lutger wrote:
> *drools*
>
> Some more wishes:
>
> D2 support?
>
> Couple of minor suggestions for the aesthetics (this is a matter of taste too of course):
>
> - make the declarations stand out more, bold font or something.
> - all the non-comments stuff should be in a different, monospace font
> - parameters names in italic
> - name of the module as the title of the html page
>
Is it possible to have a documentation layout page, somewhere, where you explain, or list, what fonts are used for what i.e. Parameters names are in italics, etc.
thanls
Nick_B
|
July 12, 2009 Re: Descent generated documentation | ||||
---|---|---|---|---|
| ||||
Posted in reply to Nick B | Nick B escribió:
> Lutger wrote:
>> *drools*
>>
>> Some more wishes:
>>
>> D2 support?
>> Couple of minor suggestions for the aesthetics (this is a matter of taste too of course):
>> - make the declarations stand out more, bold font or something.
>> - all the non-comments stuff should be in a different, monospace font
>> - parameters names in italic
>> - name of the module as the title of the html page
>>
>
> Is it possible to have a documentation layout page, somewhere, where you explain, or list, what fonts are used for what i.e. Parameters names are in italics, etc.
I already use a stylesheet. It's in stylesheet.css.
I'll tweek the generated html further so it can be more customized. Then I'll upload a zip somewhere so others can make others stylesheets, and we can choose together one that's "best" for general use.
|
July 12, 2009 Re: Descent generated documentation | ||||
---|---|---|---|---|
| ||||
Posted in reply to Ary Borenszweig | Ary Borenszweig escribió: > Hi all! > > So... I've been playing around with generating ddocs from Descent > > phobos: http://downloads.dsource.org/projects/descent/ddoc/phobos/ > Tango: http://downloads.dsource.org/projects/descent/ddoc/tango/ Hi again! I uploaded two zip files: http://downloads.dsource.org/projects/descent/ddoc/descent_phobos_docs.zip http://downloads.dsource.org/projects/descent/ddoc/descent_tango_docs.zip They include all the docs for both libraries, and also a stylesheet.css file. Also now the generated html is indented and properly "css-classed". (but if you need some modification to the generated html, please tell me.) So you can download that and start playing with the stylesheet to make it look better. You might also want to try to include jquery in one of the generated htmls and then attach handlers to the onload event to add collapsible regions, or anything you'd like. I hope you can come up with a nice one. :) The one that looks better will stay in Descent as the default one. |
Copyright © 1999-2021 by the D Language Foundation