Forum OpenACS Development: Callbacks

Collapse
Posted by Malte Sussdorff on
I wrote a quick intro into using callbacks at http://www.cognovis.de/entwickler/tips/openacs_development/callbacks/.

It also sums up the discussion we had on IRC yesterday about secret dependencies.

Collapse
2: Re: Callbacks (response to 1)
Posted by Mark Aufflick on
Malte, on that page the first ad_proc code snippit (defining the callback) is missing the trailing - , or alternatively you're not planning for people to put documentation in there.
Collapse
3: Re: Callbacks (response to 1)
Posted by Jeff Davis on
Malte, could you please document the callbacks you have added. I see
quite a few committed by you or timo with not documentation at all about
what they do or what the expected return is.
Collapse
4: Re: Callbacks (response to 1)
Posted by Malte Sussdorff on
I guess I'm missing something. Where shall I put the documentation for the callbacks (not the callback implementation)
Collapse
5: Re: Callbacks (response to 1)
Posted by Mark Aufflick on
Malte, to give your example callback specification documentation:
ad_proc -public -callback contact::organization_new {
    {-package_id:required}
    {-contact_id:required}
    {-name:required}
} {
      Normal ad_proc style documentation goes here
      
      @param package_id The id of the package
       etc...
} -
As per the ad_proc documentation, the - on the end is effectively a null code block, thus meaning that this is a 3 block style ad_proc and the second block is the documentation block.