You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Mikael Lundgren <mi...@leanon.se> on 2003/11/25 10:22:31 UTC

Multiproject javadoc

Hi,

I guess this sholud be rather easy... but I can't think properly right 
now so I'm turning to the extended brain for counsel.

I have a project that is divided into 6 subprojects:

main
  |-project1
  |-project2
  |-folder
    |-project3
    |-project4
    |-project5
    |-project6

Each some projects have dependencies on other within the main project.

I am using multiproject to build a common site and I would like to 
create a common aggregated javadoc (and possibly source cross references 
as well) for all the projects. As it is now I need to go to the 
individual projects for the docs.

Any ideas? Pointers?

Thanks
/Mikael Lundgren


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


Re: Multiproject javadoc

Posted by di...@multitask.com.au.
Make your own navigation.xml from the ones provided by multiproject.

Look in 
multiproject/src/plugin-resources/templates/navigation-aggregate.xml for a 
sample.
--
dIon Gillard, Multitask Consulting
Blog:      http://blogs.codehaus.org/people/dion/



Mikael Lundgren <mi...@leanon.se> wrote on 27/11/2003 07:21:43 
AM:

> Then again... it turns out that creating my own navigation.xml overrides 

> the one created by running maven multiproject thus hiding my "child" 
sites.
> 
> This is overcome by explicitly (sp?) putting all the links in my own 
> hand made navigation xml. It seems logical that the multiproject plugin 
> would reuse the navigation.xml facility. Is there any way to combine the 

> navigation.xml generated by multiproject with the one created by hand 
> for navigating non-standard content?
> 
> Anyway, now my site looks lite I wanted it to.
> 
> Cheers /Mikael
> 
> Mikael Lundgren wrote:
> 
> > Thanks...
> > 
> > sometimes the answer is painfully obvious ;-)
> > 
> > Cheers
> > /Mikael
> > 
> > Stephen McConnell wrote:
> > 
> >>
> >>
> >> Mikael Lundgren wrote:
> >>
> >>> Now, if only I could get a link to this javadoc to magically appear 
> >>> in the home page of the top project... that would be something!!! 
> >>
> >>
> >>
> >>
> >> You can do this by including a link to the javadoc root in the 
> >> navigation.xml. If you take a look at the Merlin docs you will see 
the 
> >> complete system APIs referenced at the top level:
> >>
> >> http://avalon.apache.org/merlin
> >>
> >> The sources for the site docs are in the merlin/platform/xdocs 
directory.
> >>
> >> Cheers, Steve.
> 
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
> 


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


Re: Multiproject javadoc

Posted by Mikael Lundgren <mi...@leanon.se>.
Then again... it turns out that creating my own navigation.xml overrides 
the one created by running maven multiproject thus hiding my "child" sites.

This is overcome by explicitly (sp?) putting all the links in my own 
hand made navigation xml. It seems logical that the multiproject plugin 
would reuse the navigation.xml facility. Is there any way to combine the 
navigation.xml generated by multiproject with the one created by hand 
for navigating non-standard content?

Anyway, now my site looks lite I wanted it to.

Cheers /Mikael

Mikael Lundgren wrote:

> Thanks...
> 
> sometimes the answer is painfully obvious ;-)
> 
> Cheers
> /Mikael
> 
> Stephen McConnell wrote:
> 
>>
>>
>> Mikael Lundgren wrote:
>>
>>> Now, if only I could get a link to this javadoc to magically appear 
>>> in the home page of the top project... that would be something!!! 
>>
>>
>>
>>
>> You can do this by including a link to the javadoc root in the 
>> navigation.xml. If you take a look at the Merlin docs you will see the 
>> complete system APIs referenced at the top level:
>>
>> http://avalon.apache.org/merlin
>>
>> The sources for the site docs are in the merlin/platform/xdocs directory.
>>
>> Cheers, Steve.



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


Re: Multiproject javadoc

Posted by Mikael Lundgren <mi...@leanon.se>.
Thanks...

sometimes the answer is painfully obvious ;-)

Cheers
/Mikael

Stephen McConnell wrote:
> 
> 
> Mikael Lundgren wrote:
> 
>> Now, if only I could get a link to this javadoc to magically appear in 
>> the home page of the top project... that would be something!!! 
> 
> 
> 
> You can do this by including a link to the javadoc root in the 
> navigation.xml. If you take a look at the Merlin docs you will see the 
> complete system APIs referenced at the top level:
> 
> http://avalon.apache.org/merlin
> 
> The sources for the site docs are in the merlin/platform/xdocs directory.
> 
> Cheers, Steve.


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


Re: Multiproject javadoc

Posted by Stephen McConnell <mc...@apache.org>.

Mikael Lundgren wrote:

> Ok, guys...
>
> I realize this was a bit too simple ;-)
>
> But, the thread about Merlin that appeared here earlier today got me 
> the answer... so I looked at Merlin in CVS, in particular at the 
> maven.xml for the Merlin project and voilá ;-) Now I can build 
> aggregated javadocs for my 6 subprojects!
>
> Now, if only I could get a link to this javadoc to magically appear in 
> the home page of the top project... that would be something!!! 


You can do this by including a link to the javadoc root in the 
navigation.xml. If you take a look at the Merlin docs you will see the 
complete system APIs referenced at the top level:

http://avalon.apache.org/merlin

The sources for the site docs are in the merlin/platform/xdocs directory.

Cheers, Steve.

-- 

Stephen J. McConnell
mailto:mcconnell@apache.org

|------------------------------------------------|
| Magic by Merlin                                |
| Production by Avalon                           |
|                                                |
| http://avalon.apache.org/merlin                |
| http://dpml.net/                               |
|------------------------------------------------|





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


Re: Multiproject javadoc

Posted by Mikael Lundgren <mi...@leanon.se>.
Ok, guys...

I realize this was a bit too simple ;-)

But, the thread about Merlin that appeared here earlier today got me the 
answer... so I looked at Merlin in CVS, in particular at the maven.xml 
for the Merlin project and voilá ;-) Now I can build aggregated javadocs 
for my 6 subprojects!

Now, if only I could get a link to this javadoc to magically appear in 
the home page of the top project... that would be something!!!

The project I'm working with is designed for a *very* business critical 
application for and banking/finance companies. Maven is coming very 
handy for giving the project a face by aggregating reports, documents 
etc into one easily accessible place.

I am counting on using Maven throughout the projects as of today really 
since I got it installed on the build machine yesterday (all I have to 
do is add my own homegrown Subversion patch for the changelog plugin, 
which btw now also handles date ranges according to the latest 
Subversion 0.33.1).

Cheers

/Mikael Lundgren


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