Book a Demo

Author Topic: javadoc documentation  (Read 3829 times)

Ohad Young

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
javadoc documentation
« on: May 01, 2009, 12:01:00 am »
Hi,

I imported java source code to a model.  The java source code contains javadoc for classes, operations etc.  The documentation of the operations is not identical to its javadoc counterpart.
javadoc for example:
    /**
     * Describes a scoping entity supported by the service.
     *
     * @param seId
     *            Scoping entity identifier.
     * @return The description of the scoping entity.
     * @throws UnrecognizedEntityException
     *             The scoping entity is not recognized by the service.
     * @see ScopingEntityDO
     */

Model operation documentation:
Describes a scoping entity supported by the service.
@return The description of the scoping entity.
@see ScopingEntityDO

The operation's @throws and @param javadoc is missing from the documentation in the model.

Is there a way to resolve it?

Thanks, Ohad

Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: javadoc documentation
« Reply #1 on: May 01, 2009, 08:19:52 am »
Throws has went into the tagged value notes.
Param has went into the parameter notes.

Ohad Young

  • EA Novice
  • *
  • Posts: 6
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: javadoc documentation
« Reply #2 on: May 01, 2009, 09:22:46 pm »
got it, thanks!
Is it possible to display tagged value notes and parameter notes in a diagram?

Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: javadoc documentation
« Reply #3 on: May 04, 2009, 08:40:08 am »
No, neither are currently possible to display on the diagram.