#270 JavadocStyle to ensure the presence of a sentence

release_3.4
closed
Check (274)
5
2012-10-10
2003-11-25
David Ufton
No

I would like to request an additional property for the
JavadocStyle task. There is currently no way of making
sure that the javadoc contains a sentence. The
checkFirstSentence property ensures that if a sentence
is present it must end with a full stop, question mark,
etc, but if no sentence is entered, the check passes.
For example, the following code does not cause a failure...

/*
* @return Date

/
public Date getStart()
{
return start;
}

What I would like is a property I can set which will
force a sentence to be present.

Discussion

  • Lars Kühne
    Lars Kühne
    2003-11-26

    Logged In: YES
    user_id=401384

    Please clarify spec: Should

    /
    {@inheritDoc}
    /
    public Date getStart()
    {
    return start;
    }

    cause a failure because there is no sentence present?

     
  • David Ufton
    David Ufton
    2003-11-26

    Logged In: YES
    user_id=787032

    I would say that because the point of {@inheritDoc} is to
    inherit documentation from the nearest inheritable class or
    interface, it would not cause a failure.

     
  • Logged In: YES
    user_id=746148

    Patch 903597 (Find empty Javadoc with JavadocStyleCheck)
    from Daniel Grenner which implements this rfe committed to
    CVS for 3.4