[Bf-committers] improving developer documentation

[Ben Batt]

Hi Tom,

I'd just like to back up David's points:

Some kind of up-to-date guide to the source tree structure would be
nice. It's a bit hard when you're starting out to find the files you
need to change.

Function specifications would also be very helpful. Just some comments
in the header files saying what the function does would go a long way.
It's hard to have to read the entire source code of a function in
order to use it.

Another thing that would be nice is an indication of which
files/functions are deprecated. I've come across a couple of things
that seem to be duplicated, and I'm not sure which one to use.

Previous development experience: I'm a final year computer science
student. I haven't worked on any open source projects before.

Let me know if I can help!

Thanks,
Ben (Artificer)

On 2/14/06, David Millán Escrivá <david at artresnet.com> wrote:
>  Hi Tom.
>
>  I start with blender code, I think that all people who start with blender
> code they are experimented c developers.
>
>  My first problem with the code is that I don't know the structure of files
> and her organization.
>  Second, I don't find the specifications of general functions (buttons,
> etc...)
>
>  The people that start developing blender need the specifications of
> functions and organization of files first.
>
>  I hope redocument all code.
>
>  If I can help,send me mail.
>  david at artresnet.com
>
>  Pd. Sorry to may bad English
>
>  Tom M escribió:
>  I'd like to organize an effort to improve the documentation for use by
> new developers.
>
> It would be excellent for those who have begun to work on Blender or
> those who remember their 'first steps with Blender' if you could email
> me areas you had particular trouble with ie things like building from
> source gotchas you needed to overcome, difficulties you had in
> locating information needed in the source code, or figuring out where
> to ask questions, etc. Or at a higher level references you needed to
> use for algorithm design. As well as any additional resources you'd
> recommend.
>
> Also it would be good to get an idea of what previous development
> experience you had, ie whether you have worked on previous open source
> projects. If you are a professional programmer, the build
> environments you've used etc
>
> As a first step I'll likely transfer the current developer docs to the wiki
>
> http://www.blender.org/cms/Development.81.0.html
>
> as well as integrate the stuff that is wiki only, or in the blender
> /docs folder in the source.
>
> Then I'll work on adopting best practices from other open source
> development projects developers guides and resources. See below for
> some open source developer documentation from other projects.
>
> LetterRip
>
> Mozilla
> http://www.mozilla.org/docs/
>
> OpenOffice
> http://development.openoffice.org/
> http://api.openoffice.org/DevelopersGuide/DevelopersGuide.html
>
> Bugzilla
> http://www.bugzilla.org/docs/developer.html
>
> Python
> http://www.python.org/dev/
>
> Darwin - good points - quick start guide, tech overview, development
> learning paths
> http://developer.apple.com/documentation/Darwin/index.html
>
> Gnome - good points - 'helping', release planning,
> http://developer.gnome.org/doc/
> http://developer.gnome.org/helping/
>
> Ogre
> http://www.ogre3d.org/docs/manual/
> http://www.ogre3d.org/index.php?option=com_content&task=blogcategory&id=74&Itemid=87
> http://www.ogre3d.org/wiki/index.php/Main_Page
> _______________________________________________
> Bf-committers mailing list
> Bf-committers at projects.blender.org
> http://projects.blender.org/mailman/listinfo/bf-committers
>
>
>
>
>
>
> --
>
>
>
>
>
>
>
>
>
>
> Artres Comunicación Valencia, Sociedad Limitada.
>  Calle Reina Doña Germana, 10, puerta 3.
>  Tel. 963 330 407 // Fax: 963 330 805
>  E-mail: artres at artresnet.com
>
> AVISO: Este mensaje electrónico, así como cualquier documento adjunto, es
> para uso exclusivo del destinatario (s) especificado, pudiendo contener
> información privilegiada, protegida o confidencial que no necesariamente
> refleja la opinión de la empresa. Si recibe este mensaje por error, le
> rogamos nos lo comunique inmediatamente por la misma vía o por teléfono (+34
> 963 330 407) y lo elimine de su ordenador, ya que usted no está autorizado
> al uso, revelación, distribución, impresión o copia de toda o alguna parte
> de la información contenida.
>
> DISCLAIMER: This message, as well as any attachments, is intended solely for
> the use of the addressee (s) identified herein, and it may contain
> privileged, protected, or confidential information that may not necessarily
> represent the opinion of the organization. If you have received this message
> by mistake, please contact the sender immediately by e-mail or telephone
> reply (+34 963 330 407) and proceed to delete this message from your
> computer since you are not authorized  to use, disclose, distribute, print
> or copy all or part of the contained information. Thank you.
> _______________________________________________
> Bf-committers mailing list
> Bf-committers at projects.blender.org
> http://projects.blender.org/mailman/listinfo/bf-committers
>
>
>