Re: [Jsdoc-user] Adding a tag

[Gabriel R. <gab...@gm...>]

On Thu, Oct 27, 2005 at 05:12:56PM +0200, sch...@ma... wrote:
> Hi we use a adapter in js/xul to server, that gives us  results of
> cobol methods.
> These data is stored in meber classes noted like
> 
> MY_CLASS.pprototype.basic = {
>  a: '',
>  b: '',
>  c: ''
> }
> 
> MY_CLASS.pprototype.set_basic = function(data){
> 
> }
> 
> coming from cobol method get_basic So far all this methods are
> accessible via a web iterface, describing all in & output data
> structures. i just need to add following tag to the document
> 
> @cobol get_basic
> 
> and i need a <a
> href="http://mysite.com/dd/index.php?method=get_basic">Cobolmethdod:
> get_basic</a>


Adding the following segment to the .jsdoc_config file should do the
trick:

##############################################################################
$METHOD_ATTRS_MAP{cobol} =
    sub {
        "Cobol method: <a href='http://mysite.com/dd/index.php?method=" .
            $_[0][0] . "'>" . $_[0][0] . "</a>";
    };
##############################################################################

That will add a link to the method description (of the method where the
@cobol tag is used).

By the way, if you don't mind (and are allowed) to tell a bit more about
the JavaScript/Cobol link, I'd certainly be interested in hearing more
about it!


Gabriel