Mailing-List: contact users-help@maven.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Maven Users List" <users@maven.apache.org>
Received-SPF: pass (athena.apache.org: domain of mikael.petterson@ericsson.com
 designates 193.180.251.45 as permitted sender)
From: Mikael Petterson <mikael.petterson@ericsson.com>
To: Maven Users List <users@maven.apache.org>
Subject: FW: How to include @inheritDoc from a dependent jar
Thread-Topic: How to include @inheritDoc from a dependent jar
Thread-Index: Ac8RHu3sDnEMqH6hSWezTLshbA+znP//+R+A///g+7D//oneIA==
Date: Wed, 15 Jan 2014 08:20:26 +0000
Message-ID: <F9336B99542D204B8167E81E41261BE111F5CE@ESESSMB109.ericsson.se>
References: <F9336B99542D204B8167E81E41261BE111DF9F@ESESSMB109.ericsson.se>
 <BLU172-W48D048E6778CF722B380F8AEBF0@phx.gbl>
Accept-Language: sv-SE, en-US
Content-Language: en-US
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0

Hi,

New try :-)

I have the following:

Interface in dependency jar javadoc:

/**
     * Deletes the object found at the specified location.
     *=20
     * @param Object any type of object
     * @throws InvalidObjectException lots of text
     * @throws NoSuchObjectException lots of text
     */
public void delete (Object object)throws throws InvalidObjectException, NoS=
uchObjectException;

Implementing class:

/**
     * {@inheritDoc}
     */
    @Override
    public void delete(Object object) throws InvalidObjectException, NoSuch=
ObjectException {
	//implementation of delete
    }

Is this correct or?   Since this will not produce any javadoc for implement=
ation of delete ( last code).   =20

Do I need to do anything special in the maven javadoc plugin?


Br.

//mike

-----Original Message-----
From: Martin Gainty [mailto:mgainty@hotmail.com]
Sent: den 14 januari 2014 13:27
To: users@maven.apache.org
Subject: RE: How to include @inheritDoc from a dependent jar

 =20


> From: mikael.petterson@ericsson.com
> To: users@maven.apache.org
> Subject: How to include @inheritDoc from a dependent jar
> Date: Tue, 14 Jan 2014 12:14:21 +0000
>=20
> Hi,
>=20
> We are building a maven site that will contain javadoc for our AppX api (=
 jar file).
> AppX depends on a few other jar files ( that we have built using maven) .=
 One dependency jar contain an interface with javadoc and we have a class i=
mplementing it, in AppX.
> AppX has @inheritDoc in in the javadoc so we don't have to rewrite it.
>=20
> When I use the following under <report>
>=20
> <plugin>
> <groupId>org.apache.maven.plugins</groupId>
> <artifactId>maven-javadoc-plugin</artifactId>
> <version>2.8.1</version>
> </plugin>
>=20
> But when I open up the javadoc for my Appx and look at the class implemen=
ting the interface there is no javadoc. What am I missing?

MG>@Inheritdoc pulls Javadoc comments @comment @author @param @throws=20
MG>@return from Implemented interface If you have none of the Javadoc=20
MG>tags in the corresponding base method of implemented interface then=20
MG>AppX class will not be able to 'inherit' those Javadoc attributes
=20
> Br,
>=20
> //mike
"The longest journey is the the journey inwards..Of him who has chosen his =
dentiny..Who has started upon his quest for the source of his being".... Da=
g Hammarskjold
 		 	   		 =20

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org