Bug 14608 – Enum members should be formatted as a table

Consider e.g. http://dlang.org/phobos-prerelease/std_algorithm_searching.html#.OpenRight. There, we have a lavishly laid itemization for only little content. All enum values have one-word declarations and short descriptions. It would be great if they were laid instead as a table (similar to "Params:") with two columns (name and description). There should be no "Jump to" for the values. The ddox-based documentation is actually worse - it generates one page per enum value (see e.g. http://dlang.org/library/std/algorithm/searching/open_right.no.html. Most of those pages are fluff. Enums should be compressed to one page with all values and their descriptions on it.

I've assigned Sönke for now, please reassign appropriately. Thanks!

Note - refer to the "display" CSS property: https://developer.mozilla.org/en-US/docs/Web/CSS/display#Values

Note that while the DDOX based documentation has a per-item page, it also has an overview table: http://dlang.org/library/std/algorithm/searching/open_right.html So it's a matter of simply skipping the generation of the per-item pages. However, sometimes there might be more than a one-liner description, so the table would have to be able to display that, too (e.g. like https://msdn.microsoft.com/en-us/library/windows/desktop/ff700543%28v=vs.85%29.aspx).

PR for the DDOX side: https://github.com/dlang/dlang.org/pull/1319 BTW, an example for a more detailed enum member documentation: http://dlang.org/phobos/core_memory.html#.GC.BlkAttr.APPENDABLE

Commits pushed to master at https://github.com/dlang/dlang.org https://github.com/dlang/dlang.org/commit/926b20648ca3b6199ecdc2fbd1d2fdeef45aa280 Upgrade to DDOX 0.15.4 - Fixes the DDOX part of issue 14608. - Removes per-enum-member pages and instead displays the full enum member documentation inside of a single table - Adds template arguments and constraints display for composite types and enums https://github.com/dlang/dlang.org/commit/f806372cf2b11cc9c64eec9fa061e63c723b494c Merge pull request #1319 from s-ludwig/master Upgrade to DDOX 0.15.4 - Fixes the DDOX part of issue 14608.

So should we close this?

Commits pushed to stable at https://github.com/dlang/dlang.org https://github.com/dlang/dlang.org/commit/926b20648ca3b6199ecdc2fbd1d2fdeef45aa280 Upgrade to DDOX 0.15.4 - Fixes the DDOX part of issue 14608. https://github.com/dlang/dlang.org/commit/f806372cf2b11cc9c64eec9fa061e63c723b494c Merge pull request #1319 from s-ludwig/master

Looks like this is fixed now, right Sönke?

Yes, fixed for /library/. I think I just didn't close this right away at the time because it still isn't fixed for /phobos/.

Thanks. Yah, I'm reopening this. Looking e.g. at http://dlang.org/phobos-prerelease/std_algorithm_comparison.html#.EditOp - a table would be so much nicer.

THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/dlang.org/issues/4041 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB