Re: Git and Documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Yes I guess I could.  I am a little new at this.   I got the same idea
after watching Stephen Wood's video here:
http://developer.yahoo.com/yui/theater/video.php?v=woods-yuiconf2009-yuidoc
.  He had 3 rules/guidelines that might work if we use YUI Doc to
generate the documentation:

1) Generate documentation as part of the build
2) Don’t manually check documentation in to VCS (do it automatically)
3) Treat documentation comments like code

I am not sure how to make it run as part of my build process though.

On Mon, Aug 9, 2010 at 4:43 PM, Ævar Arnfjörð Bjarmason
<avarab@xxxxxxxxx> wrote:
> On Mon, Aug 9, 2010 at 17:35, Sultan Shakir <sshakirflhosp@xxxxxxxxx> wrote:
>> Dear Git Community:
>> My organization is exploring using Git to manage our code repository.
>> We also have a strong need for documentation of our code.  The code is
>> written in a proprietary language (Discern Explorer/CCL).  We looked
>> into Natural Docs but don't think we can combine it with Git.  Does
>> anyone know of an app where we can combine the power of Git and code
>> documentation in one?  Thank you. -Sultan
>
> Can you be clearer. That question makes little sense.
>
> You can keep your documentation *in* Git if it's in files that you can
> keep in version control. So in that case you could keep it alongside
> your code.
>
> Can't you use this approach?
>
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]