OpenEuphoria

Euphoria Ticket #290: eudoc ignores all but the first enum on the same line coma seperated

• Reported by ne1uno Nov 01, 2010
• 3 comments

 
public enum YEARS, MONTHS, WEEKS, DAYS, HOURS, MINUTES, SECONDS, DATE 
 

Details

1. Comment by ne1uno Nov 01, 2010

changed the markup in datetime.e from --** to --**** ahead of the Accessors to workaround eudoc ignoring the rest of the enums in that block. it didn't matter if they were on the same line or not

2. Comment by DerekParnell Nov 01, 2010

This needs to be fixed now rather than later. I'll have a look.

3. Comment by jeremy Nov 04, 2010

public enum YEARS, MONTHS, WEEKS, DAYS, HOURS, MINUTES, SECONDS, DATE 

gets processed correctly via EuDOC.

--** 
-- Date/Time ENUM 
public enum YEARS, MONTHS, WEEKS, ... 

Does not get properly processed by eudoc. EuDOC can handle this more gracefully but I don't think this is a 4.0.0 blocker. The proper way to comment the above enum is actually:

--**** 
-- === Intervals 
 
public enum 
  --** 
  -- Interval representing a number of years 
  YEARS, 
 
  --** 
  -- Interval representing a number of months 
  MONTHS, 
 
  -- ... ... etc ... 

What would you expected

--** 
-- Interval Enum 
public enum YEARS, MONTHS, ... 

To actually do? --** is a comment attached to a section of code, the first section of code. Thus it gets attached to YEARS. Now, eudoc should output YEARS with the comment "Interval enum" in the above case and also output "MONTHS, WEEKS, ..." with no comment. That's proper eudoc which it doesn't do correctly, but it's poor documentation.

Therefore, I am moving this to a 4.1 ticket. There are many other things that we want eudoc to do, this can be one of them.

I did, however, update std/datetime.e for the proper eudoc commenting of that code structure.

Include: