- omit Efl.Object, it's always there in a way or another :-D - omit duplicates - hide (fold) indirect by default, have an "expand [+]" action that will toggle the css class visibility
On Wed, Nov 22, 2017 at 1:07 AM, Jean-Philippe André <j...@videolan.org> wrote: > Hi, > > 2017-11-22 9:14 GMT+09:00 Carsten Haitzler <ras...@rasterman.com>: > >> On Tue, 21 Nov 2017 16:57:18 +0000 Andrew Williams <a...@andywilliams.me> >> said: >> >> > Hi team, >> > >> > Looking at some of our larger inheritance trees, such as >> > https://www.enlightenment.org/develop/api/class/efl/ui/clock , may >> provide >> > only 8 members but the page runs to hundreds of items - a complete bed >> time >> > read in itself. I think for the sanity of our readers it would be good to >> > list the members it inherits in short hand. Like the somewhat >> standardised >> > JavaDoc output - >> > https://docs.oracle.com/javase/7/docs/api/java/io/ >> OutputStreamWriter.html >> > >> > Additionally the complete heirarchy tree at the top of each page takes a >> > lot of space and repeats a lot - it would make sense to flatten this to a >> > list. >> >> I like the tree at the top... It does contain very useful information of >> where the class comes from in the scheme of things. Why not use a foldable >> section? Expand it if you want the tree, otherwise stay collapsed? >> >> Same for all of the inherited methods/properties etc. - put them all in >> foldable sections you expand? >> > > The tree view in our doc pages has some issues indeed. It repeats the same > classes multiple times (multiple inheritance leading to that), like > Efl.Object on the page Andy mentioned. > I think it would be acceptable to separate between direct inheritance and > interfaces, like in JavaDoc? Not sure where mixins would go, maybe in a > special category as well. > > In JavaDoc, QtDoc and all, we also find usually a summary of the methods, > and the inherited methods, with links to the full description. > We already have this separation (full doc for edit_mode is under its own > page: > https://www.enlightenment.org/develop/api/class/efl/ui/clock/property/edit_mode) > but the view is probably not condensed enough. Basically the table view in > "Method Summary" is good but could be better if left side as the method > name (+get/set), right side the brief description and maybe a > pseudo-language signature, if that's possible. > > PS: The inheritance graph picture should not be generated with a max size, > as it becomes unreadable. > > -- > Jean-Philippe André > ------------------------------------------------------------------------------ > Check out the vibrant tech community on one of the world's most > engaging tech sites, Slashdot.org! http://sdm.link/slashdot > _______________________________________________ > enlightenment-devel mailing list > enlightenment-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel -- Gustavo Sverzut Barbieri -------------------------------------- Mobile: +55 (16) 99354-9890 ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
