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.

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

[autogsdoc] should be refactored to support multiple output formats #425

Open
gcasa opened this issue Jul 24, 2024 · 3 comments
Open

[autogsdoc] should be refactored to support multiple output formats #425

gcasa opened this issue Jul 24, 2024 · 3 comments
Assignees
Labels
enhancement Label issues that propose improvements to existing features. feature request Suggest new features or enhancements to existing functionalities with this tag.

Comments

@gcasa
Copy link
Member

gcasa commented Jul 24, 2024

As it stands autogsdoc is an excellent tool for generating documentation from GNUstep's headers, but it is limited to HTML output. Indeed, it uses some antiquated tags from older versions of HTML, namely and to name a few. I see the following issues:

  1. The current implementation of HTML generation needs to be reviewed and updated... get rid of older tags, make the generated HTML more capable of having CSS applied
  2. The generation itself needs to be looked at such that other formats could be generated for example: Markdown or formats capable of being parsed by other document generators
  3. Code cleanup

GC

@gcasa gcasa added enhancement Label issues that propose improvements to existing features. feature request Suggest new features or enhancements to existing functionalities with this tag. labels Jul 24, 2024
@gcasa gcasa self-assigned this Jul 24, 2024
@rfm
Copy link
Contributor

rfm commented Jul 25, 2024

Umm ... autogsdoc has never been limited to HTML output. It was designed from scratch to produce XML (specifically the gsdoc grammar in xml), on the assumption that people could xslt (or other mechanisms) to convert the XML to other formats as required, but with an extra phase to directly produce HTML from the XML. Of course anyone is welcome to provide other styles of output.
That being said, the generated HTML is old fashioned, and would definitely benefit from updating, as suggested, by someone familiar with the use of CSS.

@gcasa
Copy link
Member Author

gcasa commented Jul 25, 2024

Umm ... autogsdoc has never been limited to HTML output. It was designed from scratch to produce XML (specifically the gsdoc grammar in xml), on the assumption that people could xslt (or other mechanisms) to convert the XML to other formats as required, but with an extra phase to directly produce HTML from the XML. Of course anyone is welcome to provide other styles of output. That being said, the generated HTML is old fashioned, and would definitely benefit from updating, as suggested, by someone familiar with the use of CSS.

AH SWEET!!! That's hugely exciting. I think then, the HTML should be updated and... we should create parsers to output different formats. Nice! :). I wasn't sure if autogsdoc generated the HTML directly or not I have never worked on that tool. I apologize for my misunderstanding.

@rmottola
Copy link
Member

HTML output has been quite updated... as far as I checked, it is HTML5 compliant, but we might want to run some check tool on it to be sure some older tag/style didn't slip in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Label issues that propose improvements to existing features. feature request Suggest new features or enhancements to existing functionalities with this tag.
Development

No branches or pull requests

3 participants