GithubHelp home page GithubHelp logo

Callback tag/type about yuidoc HOT 5 OPEN

yui avatar yui commented on August 20, 2024
Callback tag/type

from yuidoc.

Comments (5)

gagle avatar gagle commented on August 20, 2024

I also think this would be nice...

Currently for callback parameters I use helpers that applies the same css:

@param {Function} cb Callback to notify the result.

It receives one parameter:

* error {{#Object}}{{/Object}}  
Error or <code>null</code>.

result: http://image.gxzone.com/images/f/d/fdb05564fe5.png

helpers:

var def = function (type){
    module.exports[type] = function (){
        return "<a target='_blank' class='crosslink external type' style='border-bottom: 1px do" +
                "tted #AFAFAF' onmouseover='this.style.borderBottom = \"\";' onmouseout='this.s" +
                "tyle.borderBottom = \"1px dotted #AFAFAF\";' href='https://developer.mozilla.o" +
                "rg/en/JavaScript/Reference/Global_Objects/" + type + "'>" + type + "</a>";
    };
};

module.exports = {};
def ("Array");
def ("Boolean");
def ("Date");
def ("Function");
def ("Iterator");
def ("Number");
def ("Object");
def ("RegExp");
def ("String");

from yuidoc.

wbyoung avatar wbyoung commented on August 20, 2024

Other documentation tools that I've used have a typedef type feature that generalizes this.

from yuidoc.

visionscaper avatar visionscaper commented on August 20, 2024

I would be very interested in a YUIDoc implementation of typedef as well (JSDoc3 has it). It is cumbersome to specify the same callback definition everywhere you use it over and over again.

from yuidoc.

okuryu avatar okuryu commented on August 20, 2024

OK, OK. I'd take a look in the near future. All thoughts are appreciated for now.

from yuidoc.

visionscaper avatar visionscaper commented on August 20, 2024

@okuryu :D

from yuidoc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.