compiler icon indicating copy to clipboard operation
compiler copied to clipboard

Documentation improvement ▼

Open Dayvison opened this issue 8 years ago • 9 comments

  • [x] Add location tag <location file="" startline="" endline="">
  • [x] Fix transition tag
  • [ ] Escape special characters in documentation
  • [x] Fix enumerators documentation
  • [x] Fix constant documentation
  • [x] Add documentation for enumerators items
  • [x] Add new atributes for member
    • [x] const
    • [x] deprecated
    • [x] entry
    • [x] enum
    • [x] enum_field
    • [x] forward
    • [x] missing
    • [x] naked
    • [x] native
    • [x] pre_defined
    • [x] prototyped
    • [x] public
    • [x] returns
    • [ ] return_type
    • [x] static
    • [x] stock
    • [x] unused
  • [x] Update pawndoc.xsl to support new features
  • [ ] Fix a bug, when you documentate one prototype without keyword forward the documentation go to global

Dayvison avatar Feb 03 '18 21:02 Dayvison

I don't know what will be the tests for this.

I've change how the compiler check if symbol are static, but don't worry all work fine(Tested)

Dayvison avatar Feb 03 '18 21:02 Dayvison

I use several organisational tags, including <section>, <subsection>, and <library>. It would be nice if these were properly hierarchical so that functions declared within one stayed within it.

Better yet, one generic <section> (or similar) tag that can nest other sections and language features, and would take parameters to determine what sort of section it was to make the possibilities endless.

Y-Less avatar Feb 03 '18 21:02 Y-Less

Can you give a example of usage?

Dayvison avatar Feb 03 '18 21:02 Dayvison

@YashasSamaga @Y-Less The actual way is ignore all unused symbols, in my opinion even symbol are unused they should go to documentation, with unused attribute

Dayvison avatar Feb 04 '18 13:02 Dayvison

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Oct 26 '18 16:10 stale[bot]

@YashasSamaga You've looked in to this. Merge thoughts?

Y-Less avatar May 30 '20 17:05 Y-Less

@Dayvison can you please rebase with dev?

YashasSamaga avatar May 31 '20 08:05 YashasSamaga

This issue has been automatically marked as stale because it has not had recent activity.

stale[bot] avatar Aug 29 '20 08:08 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity.

stale[bot] avatar Dec 24 '20 11:12 stale[bot]