Re: [Jsdoc-user] public properties?

[Jake D. <jak...@ni...>]

Hi Anthony,

Documenting a public property is the same as with a method.  I'm not exactly
sure of your syntax, but likely this would work:

---snip---
/**
 * A sample public property
 * @type Number
 */
some_public_property: 2,
/**
 * A sample function
 * @param p something
 */
a_func = function(p) {
---snip---

jake

On 3/27/07, Anthony Ettinger <an...@ch...> wrote:
>
> Is it bad form to have a public property?
> I'm not seeing any way to note this in JSDoc.
>
> ie:
>
> Foo.bar: {
>      some_public_property: 2,
>      a_func: function(p) {
>
>     }
> }
>
>
> Such that I can set it with:
>
> Foo.bar.some_public_property = 3;
>
> Seems we need a JSDoc "@public" notation.
>
>
>
> --
> Anthony Ettinger
> Ph: 408-656-2473
> http://chovy.dyndns.org/resume.html
> http://utuxia.com/consulting
>
> -------------------------------------------------------------------------
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to share
> your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>