Document Revision History #124

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

4 participants

@soffes

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

@tomaz
Owner

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

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
Owner

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

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

@antoinep

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

Perhaps use git to generate automatically?

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