Menu

my AS2 comments aren't shown...

Support
2005-05-19
2012-09-14
  • Nobody/Anonymous

    hey,
    within my .as files i have used the following syntax:

    /**

    * Here comes some description bla bla
    *
    * @param item Object explaining things...
    */
    public function push(item:StackObject):Void
    {
        list_.insert(item);
    }
    

    all i am getting is the name of the method as well as its signature, BUT not the description part... what am i doing wrong?

    thanks,
    chris

     
    • Nobody/Anonymous

      ah ok ic...
      thank you sooo much! do you know when or if javaDoc commenting style is to be supported in future version? i always used to use javaDoc style so it would be quite tedious to adjust all my code now BUT i think that naturalDocs is so awesome that i would do it only to be able to use it =)

      thanks

       
      • Greg Valure

        Greg Valure - 2005-05-19

        Not soon, unfortunately. It's not likely to be in the next major release (1.4) which itself is going to take a while.

         
    • Nobody/Anonymous

      well i better start adjusting my comments than =)
      thanks

       
    • Greg Valure

      Greg Valure - 2005-05-19

      You're using JavaDoc syntax. Natural Docs doesn't support that (yet) it has its own, documented here:

      http://www.naturaldocs.org/documenting.html

      What you want is:

      /*

      • Function: insert
        *
      • Here comes some description bla bla
      • Parameters:
        *
      • item - Object explaining things...
        */
        public function push(item:StackObject):Void
        {
        list_.insert(item);
        }

      The result you're getting right now is the same you would get if you wrote nothing at all.

       

Log in to post a comment.

MongoDB Logo MongoDB