This project is read-only.
1

Resolved

Create tool to auto-generate codeplex samples docs for codeplex using the example apps.

description

Create tool to auto-generate codeplex samples docs for codeplex using the example apps.
 
NOTES:
  1. Example apps are located in : <ROOT>\src\lib\CommonLibrary.NET_samples\
  2. A template file will be used to generate the documentation ( see below )
  3. The template file has placeholders that will be replaced w/ actual data and sample code
  4. A single documentation file will be generated for all the examples in the _samples folder
    This means the template file will be used for each sample file.
     
     
    EXAMPLE DOCUMENTATION FOR ARGUMENTS COMPONENT
    ! Argument Parsing
    {code:c#}
    c# sample code goes here.
    {code:c#}
     
    http://commonlibrarynet.codeplex.com/documentation

  5. TEMPLATE FOR DOCUMENTATION OF A SINGLE EXAMPLE
    ! ${componentname}
    {code:c#}
    ${examplecode}
    {code:c#}
    Example: ${filepath}
    Date: ${dategenerated}
    Version: ${comlibversion}
     
    ${componentname} : Arguments from filepath <ROOT>\src\lib\CommonLibrary.NET_samples\Example_Arguments.cs
    ${examplecode}: Code from Example_Arguments.cs
    ${filepath}: <ROOT>\src\lib\CommonLibrary.NET_samples\Example_Arguments.cs
    ${dategenerated}: Date when the doc generator ran.
    ${comlibversion}: The version of comlib associated w/ the documentation ( Can check the assemblyversion.cs in properties folder of the project )

comments

nickntg wrote Apr 28, 2011 at 2:45 PM

First version uploaded (changeset 65789).

nickntg wrote May 12, 2011 at 2:07 PM

Tool updated to parse <doc> tag (changeset 66522).

nickntg wrote May 17, 2011 at 10:09 PM

Tool updated to read and use the _Examples.xml instructions file.

wrote May 28, 2011 at 6:28 AM

wrote May 28, 2011 at 6:29 AM

nickntg wrote Jun 5, 2011 at 12:09 PM

Tool updated to handle ${changeset} and ${sourcecontrolfileid} tags.

wrote Jun 30, 2011 at 5:57 PM

wrote Aug 8, 2012 at 12:22 AM

wrote Feb 22, 2013 at 1:03 AM

wrote May 16, 2013 at 11:57 AM

wrote May 16, 2013 at 11:57 AM

wrote Jun 14, 2013 at 8:25 AM