www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - DDoc Types

reply Trevor Parscal <trevorparscal hotmail.com> writes:
I'm unsure if anyone has mentioned this before, but it would be quite nice if
DDoc used the name of the type as it is in the code, rather than translating
aliases to their real meanings.

Example based on my real code:
---
struct Dimensional2(T)
{
T x, y;
alias x width;
alias y height;
}
alias Dimensional2!(int) Position;
alias Dimensional2!(int) Size;
---

I get Dimensional2!(int) in my ddoc output whenever I use Size or Position,
and it's hard to understand when reading the docs.

Perhaps there could be a way to adjust this behavior?
Dec 11 2006
parent Brad Roberts <braddr puremagic.com> writes:
Trevor Parscal wrote:
 I'm unsure if anyone has mentioned this before, but it would be quite nice if
 DDoc used the name of the type as it is in the code, rather than translating
 aliases to their real meanings.
 
 Example based on my real code:
 ---
 struct Dimensional2(T)
 {
 T x, y;
 alias x width;
 alias y height;
 }
 alias Dimensional2!(int) Position;
 alias Dimensional2!(int) Size;
 ---
 
 I get Dimensional2!(int) in my ddoc output whenever I use Size or Position,
 and it's hard to understand when reading the docs.
 
 Perhaps there could be a way to adjust this behavior?

see also: http://d.puremagic.com/issues/show_bug.cgi?id=644
Dec 11 2006