Thread overview
documenting compile-time constants
Jul 07, 2015
Vlad Levenfeld
Jul 07, 2015
Rikki Cattermole
Jul 07, 2015
Vlad Levenfeld
July 07, 2015
How do I ddoc an enum constant? Putting ddoc comments above functions and structs woorks fine but ddocing an enum constant doesn't generate any documentation.
July 07, 2015
On 7/07/2015 1:05 p.m., Vlad Levenfeld wrote:
> How do I ddoc an enum constant? Putting ddoc comments above functions
> and structs woorks fine but ddocing an enum constant doesn't generate
> any documentation.

If:

///
enum MyValue = 8.2f;

does not generate documentation upon its creation, please file a bug.

If:

///
enum MyEnum {
	///
	MYValue = 8.2f
}

does not generate documentation upon its creation, please file a bug.

If:

///
enum MyEnum {
	MYValue = 8.2f
}

does not generate documentation upon its creation, please see the previous answer.
July 07, 2015
On Tuesday, 7 July 2015 at 03:30:40 UTC, Rikki Cattermole wrote:
> On 7/07/2015 1:05 p.m., Vlad Levenfeld wrote:
>> How do I ddoc an enum constant? Putting ddoc comments above functions
>> and structs woorks fine but ddocing an enum constant doesn't generate
>> any documentation.
>
> If:
>
> ///
> enum MyValue = 8.2f;
>
> does not generate documentation upon its creation, please file a bug.
>
> If:
>
> ///
> enum MyEnum {
> 	///
> 	MYValue = 8.2f
> }
>
> does not generate documentation upon its creation, please file a bug.
>
> If:
>
> ///
> enum MyEnum {
> 	MYValue = 8.2f
> }
>
> does not generate documentation upon its creation, please see the previous answer.

Ok, done.

https://issues.dlang.org/show_bug.cgi?id=14778