Re: [PATCH] Docs: IR: Move 'details to user grob property list

[Mats Bengtsson]

Carl D. Sorensen wrote:
> On 4/6/09 3:48 AM, "Patrick McCarty" <address@hidden> wrote:
>
>   
> > On Mon, Apr 06, 2009 at 09:37:09AM +0200, Mats Bengtsson wrote:
> >     
> > > Patrick McCarty wrote:
> > >       
> > > > So, is the patch okay as it is?
> > > >  
> > > >         
> > > Don't refer to *.cc files for more information on the subproperties in
> > > details. These are (or at least should be) described in the
> > > corresponding *-interface documentation. See for example
> > > http://lilypond.org/doc/v2.12/Documentation/user/lilypond-internals/stem_002d
> > > interface#stem_002dinterface
> > > for documentation of the stem related subproperties.
> > >       
> > Thanks Mats, I did not think of doing that.
> >
> > This will be a task in itself.  For example, Tie has 26 different
> > subproperties of 'details to document!
> >
> >     
>
> This documentation *has* to be automatically generated.  But I don't know
> the architecture for allowing this.
>   
What do you mean? The way it's done for the Stem related subproperties 
is that the documentation is included together with the other 
stem-interface documentation at the end of the file lily/stem.cc. So, in 
a way, it's automatically generated. On the other hand, I don't see any 
need to have a similar framework as for normal grob properties, since 
each subproperty typically is only used for one specific grob, so 
there's no need to separate the subproperty definitions from the rest of 
the interface documentation.

   /Mats
> I think that we should go ahead with this patch, and leave the *.cc
> reference in, until we can figure out a way to automatically document the
> details property properly for each separate grob.
>
> That's why we created a *separate* fret-diagram-details property.  It was
> easily documented as a separaate property, with each of the details included
> in the description.
>
> Anybody up for developing a self-documenting architecture for details?
>
> Thanks,
>
> Carl
>
>   

--
=============================================
        Mats Bengtsson
        Signal Processing
        School of Electrical Engineering
        Royal Institute of Technology (KTH)
        SE-100 44  STOCKHOLM
        Sweden
        Phone: (+46) 8 790 8463                         
       Fax:   (+46) 8 790 7260
        Email: address@hidden
        WWW: http://www.s3.kth.se/~mabe
=============================================