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] doc file generation date #328

Open
rmottola opened this issue Sep 20, 2023 · 2 comments
Open

[autogsdoc] doc file generation date #328

rmottola opened this issue Sep 20, 2023 · 2 comments
Labels
enhancement Label issues that propose improvements to existing features.

Comments

@rmottola
Copy link
Member

rmottola commented Sep 20, 2023

Currently, autogsdoc tries to be smart and puts as dates those found in the header (.h first, .m if not present). It scavenges for Date, Copyright and if present Revision too. However the latter one is CVS info, not really useful.
These dates are referred to the file content.

I think somewhere (maybe at the bottom or top of the file in a different style) a generation file of the doc itself should be present. This informs the user on when the generation was run, independently of when the class was last touched itself (and maybe somebody forgot to update its header copyrights).

What do you think? @rfm @gcasa

@rfm
Copy link
Contributor

rfm commented Oct 21, 2023

Yes, this stuff seems obsolete (and perhaps never very useful to start with).
I agree that having a documentation generation timestamp (the date/time at which the headers/source were parsed) might be nice.

@rmottola
Copy link
Member Author

rmottola commented Nov 3, 2023

Current progress is good and seems to work.
We need to clean up version files around, after being done with base. (Reminder).

Also, a clean solution for index.html would be interesting. E.g. min/max of dates + list of authors coming from all files.

@hmelder hmelder added the enhancement Label issues that propose improvements to existing features. label Nov 14, 2023
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.
Development

No branches or pull requests

3 participants