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

Document Revision History #124

Open
soffes opened this issue Jul 18, 2011 · 6 comments
Open

Document Revision History #124

soffes opened this issue Jul 18, 2011 · 6 comments

Comments

@soffes
Copy link

soffes commented Jul 18, 2011

It would be great if there was a way to add Document Revision History similar to how Apple does.

@tomaz
Copy link
Owner

tomaz commented Jul 26, 2011

This would need to be implemented through some form of @ directives I guess.

Currently, you could do it manually, although I guess it'll show at the top of class documentation HTML (for static documents you would have full control over the location). And it would not show in TOC. You could use discount extensions to get either dt/dd or table out of it and then update CSS to style it properly if necessary.

@soffes
Copy link
Author

soffes commented Jul 26, 2011

I think some @ directives or maybe something like SSFoo-History.markdown if the class is SSFoo.h (since it could get large) would be awesome.

@tomaz
Copy link
Owner

tomaz commented Jul 26, 2011

Cool, separate file is good idea, perhaps one or the other, so that you can start with in-code style and once it gets too large to handle, move it to separate file.

@soffes
Copy link
Author

soffes commented Jul 26, 2011

That sounds like a great idea. It might be cool to use this same scheme for guides and such.

@antoinep
Copy link

In the same way, it would be great if we could generate source code differences docs, in the same manner as "API Differences" from Apple.

@gampleman
Copy link

Perhaps use git to generate automatically?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants