www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 9719] New: ddoc isn't generated for inner values unless the outer is documented

reply d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9719

           Summary: ddoc isn't generated for inner values unless the outer
                    is documented
           Product: D
           Version: D2
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: DMD
        AssignedTo: nobody puremagic.com
        ReportedBy: simendsjo gmail.com



struct S {
  int i; /// not generated
}

/// This must be present
struct A {
  int i; /// .. for this to be generated
}

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Mar 14 2013
next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9719


hsteoh quickfur.ath.cx changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |hsteoh quickfur.ath.cx



Isn't this a feature? Since otherwise, there would be nothing to attach the
member's docs to. If you just reparent the member's docs into the outer scope,
then you get confusing docs:

struct S {
  int i; /// suppose this is generated
}

struct T {
  int i; /// suppose this is also generated
}

Now the output might look confusing:

int i;
    suppose this is generated
int i;
    suppose this is also generated

IMO it's not a bug to require the containing scope to at least have an empty
/// so that the output would at least contain:

struct S
    int i;
        suppose this is generated
struct T
    int i;
        suppose this is also generated

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Mar 15 2013
prev sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9719


Andrej Mitrovic <andrej.mitrovich gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
                 CC|                            |andrej.mitrovich gmail.com
         Resolution|                            |INVALID


-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Mar 15 2013