[Ardour-Dev] Docu

[Alexander Hämmerle]

Hi *,

thanks for advices! Today I looked a little through the code and I have to say 
that it is refreshingly well organized, very intuitive to understand and easy 
to browse. Doesn't seem to be the great pain that I was afraid of after 
reading it contains more than 80 000 lines only for the core application. The 
coders have done a very nice job, also because there are documenting hints in 
the code itself.

What are your plans for february, Nando?

git clone git at github.com:cth103/ardour-dev-manual.git isn't accessible for me 
-> Permission denied (publickey).

Seems to be a known problem, but now I don't have time to resolve it because: 
Happy New Year to everybody! :)

alex


On Saturday 31 December 2011 02:07:29 Nando wrote:
> Thanks for the advice Robin!
> 
> On Sat, Dec 31, 2011 at 1:40 AM, Robin Gareus <robin at gareus.org> wrote:
> > Hi Alex, Nando,
> > 
> > I started with a similar question a few years ago. You can create
> > doxygen doc from the source - there's a doc/Doxyfile; but you'll find
> > that Ardour's class hierarchy itself is very intuitive (before starting
> > to browse it, think: how would you implement it) and that doxygen doc is
> > not very useful; because..
> > 
> > ..the tricky part is: How everything is linked together - in particular
> > callback signals and slots - and related to that: the threads which
> > react on particular slots.
> > 
> > One thing that I did in the beginning was reading code-changes for
> > bug-fixes or simply perusing the history using gitk. Get the whole
> > picture in small chunks.
> > 
> > ciao,
> > robin
> > 
> > On 12/31/2011 12:36 AM, Nando wrote:
> > > Yup, It looks that the reading the code is the way to go. OTOH, for
> > 
> > coding
> > 
> > > later I've found this: http://ardour.org/development
> > > 
> > > Check at the bottom for:
> > >    - The Ardour style guide <http://ardour.org/development/styleguide>
> > >    - A few notes <http://ardour.org/development/notes>
> > >    - Ardour3 object destruction
> > > 
> > > design<http://ardour.org/development/destruction>
> > > 
> > >    - Ardour3 using boost signals &
> > > 
> > > bindings<http://ardour.org/development/signals>
> > > 
> > > I'll be on the same task in february. Maybe I'll contact you then
> > > 
> > >  Alexander ;p
> > > 
> > > Cheers!
> > > 
> > > On Wed, Dec 28, 2011 at 9:21 PM, Paul Davis <paul at linuxaudiosystems.com
> > >
> > >wrote:
> > >> On Wed, Dec 28, 2011 at 3:12 PM, Alexander Hämmerle
> > >> 
> > >> <Alexander.Haemmerle at gmx.de> wrote:
> > >>> Hi,
> > >>> 
> > >>> if I want to jump into the source code a little, are there some
> > >> 
> > >> resources of
> > >> 
> > >>> Ardour3 for the time being (Doxygen-generated docs on the Ardour
> > >>> class heirarchy aren't available by now, are they?) or has one to
> > >>> find out
> > 
> > the
> > 
> > >> hard
> > >> 
> > >>> way?
> > >> 
> > >> doxygen will generate something, but its not even remotely complete
> > >> and ultimately reading the source code is the only way in.
> > >> _______________________________________________
> > >> ardour-dev mailing list
> > >> ardour-dev at lists.ardour.org
> > >> http://lists.ardour.org/listinfo.cgi/ardour-dev-ardour.org