Should generated documentation go in version control history?

Posted by dukeofgaming on Programmers See other posts from Programmers or by dukeofgaming
Published on 2012-11-13T21:28:45Z Indexed on 2012/11/13 23:22 UTC
Read the original article Hit count: 345

Filed under:

version-control

|

documentation-generation

I'm against compiled stuff going into version control, specially when it comes to compiled binaries, however, my principles are now in question after adding doxygen support for a project.

Should the hundreds of files generated by doxygen go into version control?, what is the recommended practice here?, I think the ideal would be automating the process in a server that publishes that documentation at the same time, however, there is no such server now nor there will be for some time.

© Programmers or respective owner

Related posts about version-control

In the context of the TFS version control SDK (Microsoft.TeamFoundation.VersionControl), what exactl

as seen on Stack Overflow - Search for 'Stack Overflow'
In the context of the TFS version control SDK (Microsoft.TeamFoundation.VersionControl), what exactly is deletionID? It is a property of Microsoft.TeamFoundation.VersionControl.Client.Item. It is also a parameter to some of the query methods on Microsoft.TeamFoundation.VersionControl.Client. I'm… >>> More
What are the advantages of version control systems that version each file separately?

as seen on Programmers - Search for 'Programmers'
Over the past few years I have worked with several different version control systems. For me, one of the fundamental differences between them has been whether they version files individually (each file has its own separate version numbering and history) or the repository as a whole (a "commit" or… >>> More
What are the advantages of version control systems that version each file separately?

as seen on Programmers - Search for 'Programmers'
Over the past few years I have worked with several different version control systems. For me, one of the fundamental differences between them has been whether they version files individually (each file has its own separate version numbering and history) or the repository as a whole (a "commit" or… >>> More
R and version control for the solo data analyst

as seen on Stack Overflow - Search for 'Stack Overflow'
Many data analysts that I respect use version control. For example: http://github.com/hadley/ See comments on http://permut.wordpress.com/2010/04/21/revision-control-statistics-bleg/ However, I'm evaluating whether adopting a version control system such as git would be worthwhile. A brief overview: I'm… >>> More
What version control tool can generate this header

as seen on Stack Overflow - Search for 'Stack Overflow'
This is from a sql script. What tool can generate this? Thanks --USE [MY_TABLE] GO /****** Object: StoredProcedure [dbo].[adminIncExp] Script Date: 03/05/2010 09:14:12 ******/ SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO -- ============================================= -- Author: … >>> More

Related posts about documentation-generation

Lua & Javascript documentation generation

as seen on Programmers - Search for 'Programmers'
I am in the beginning phase of create a mobile MMO with my team. The server software will be written in JavaScript using NodeJS, and the client software in Lua using Corona. We need a tool to auto-generate documentation for both the server-side and client-side code. Are there any tools which can… >>> More
displaying python's autodoc to the user (python 3.3)

as seen on Programmers - Search for 'Programmers'
I'm writing a simple command line math game, and I'm using python's autodoc for my math algorithms to help me remember, for example, what a proth number is while i'm writing the algorithm, but later on I'll want to tell that information to the user as well, so they'll know what the answer was. So… >>> More
Documentation utility for OpenEdge ABL

as seen on Programmers - Search for 'Programmers'
I have a large system in OpenEdge ABL that could use some documentation-love. Currently a team member is working on a utility that can find methods and functions and make some "Javadoc-esque" html pages out of it. It's pretty rough around the edges. Okay, it's like sawblades around the edges. I'm… >>> More
Generate HTML pages from some template

as seen on Programmers - Search for 'Programmers'
I have an open-source project for which I have to generate HTML pages to put on the web. I wanted to keep everything as simple HTML pages. The problem with this approach is if I need to change the design, I have to goto all the pages and change it. This will be tough as I have lot of pages. Is there… >>> More
printable PHP manual - 'all but the Function Reference section'

as seen on Programmers - Search for 'Programmers'
My Motivation I find it easier to learn things by reading 'offline'. I'd like to lean back and read the narrative part of a paper version of the official php manual. My Scuppered Plan My plan was to download the manual, print all but the Function Reference section and then read it. I have downloaded… >>> More