www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 11891] New: Ddoc should generate index table

https://d.puremagic.com/issues/show_bug.cgi?id=11891

           Summary: Ddoc should generate index table
           Product: D
           Version: D2
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: enhancement
          Priority: P2
         Component: DMD
        AssignedTo: nobody puremagic.com
        ReportedBy: doob me.com


--- Comment #0 from Jacob Carlborg <doob me.com> 2014-01-10 01:41:10 PST ---
Ddoc should be able to generate a table like the two on top of std.algorithm
[1]. This can be done as follows:

* Introduce a new ddoc macro, $(CATEGORY, category_name), that is recognized by
the compiler

* Add the $(CATEGORY) macro to all symbols as appropriate

* For generating the first table ddoc will use the specified $(CATEGORY) and
the symbol name the compiler already knows about

* For the second table it would do the same as above but also include the
summary (first paragraph) from the documentation of the symbol

* If a symbol is missing the $(CATEGORY) macro it's still listed in the table
but not in a category

[1] http://dlang.org/phobos/std_algorithm.html

-- 
Configure issuemail: https://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Jan 10 2014