Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation improvement ▼ #282

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Documentation improvement ▼ #282

wants to merge 7 commits into from

Conversation

Dayvison
Copy link

@Dayvison Dayvison commented Feb 3, 2018 •
edited
Loading

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

@Dayvison
Fix enum_root and constants documentation detection, add `enum_fi…
6f98944 
…eld` documentation
@Dayvison
Added location tag and new attributes for documentation
f2a7a6f 
I've change how the compiler check if symbol are static, but don't worry all work fine
@Dayvison
Fix transition
00218b4
@Dayvison
Fix typo
8556f4f 
Remove xml escape
@Dayvison
Update pawndoc.xsl
47b6a87 
remove comments from sc1.
Missed /
Fixed constant location
@Dayvison
Copy link
Author

Dayvison commented Feb 3, 2018

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)

@Y-Less
Copy link
Member

Y-Less commented Feb 3, 2018 •
edited
Loading

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.

@Dayvison
Copy link
Author

Dayvison commented Feb 3, 2018 •
edited
Loading

Can you give a example of usage?

@Dayvison
Copy link
Author

Dayvison commented Feb 4, 2018

@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

@stale
Copy link

stale bot commented Oct 26, 2018

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 stale bot added the state: stale label Oct 26, 2018
@Y-Less
Copy link
Member

Y-Less commented May 30, 2020

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

@stale stale bot removed the state: stale label May 30, 2020
@YashasSamaga
Copy link
Member

YashasSamaga commented May 31, 2020 •
edited
Loading

@Dayvison can you please rebase with dev?

@stale
Copy link

stale bot commented Aug 29, 2020

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

@stale stale bot added the state: stale label Aug 29, 2020
@Dayvison Dayvison requested a review from a team as a code owner September 20, 2020 11:50
@stale stale bot removed the state: stale label Sep 20, 2020
@stale
Copy link

stale bot commented Dec 24, 2020

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

@stale stale bot added the state: stale label Dec 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@YashasSamaga YashasSamaga YashasSamaga left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
state: stale
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Dayvison @Y-Less @YashasSamaga