Re: GNUstep autogsdoc

[Richard Frith-Macdonald]

On 31 Dec 2004, at 13:08, Thomas Gamper wrote:

> Hi!
>
> I have some questions reguarding the autogsdoc tool. I am using your 
> tool to
> generate documentation for a large software project at the Technical
> University of Vienna. The software I'm talking about consists of a 
> large set
> of libraries written in Objective-C. I was able to generate 
> documentation
> separately for each of the libraries, but I failed to index the 
> documentation
> I created for other libraries. In detail: I generate documentation for 
> the
> base library called libObjective using
>
> autogsdoc -Project libObjective  -MakeFrames YES 
> -DocumentationDirectory
> ~/arthtml/libObjective  *.h
>
> then I generate documentation for the next library, libNode,using 
> autogsdoc
> -Project libNode -Projects ~/arthtml/libObjective/libObjective.igsdoc
> -MakeFrames YES -DocumentationDirectory ~/arthtml/libNode  *.h
>
> But there is no hyperlink between classes in libNode and their 
> superclasses in
> libObjective. What am I doing wrong?

If your libObjective project has already been installed in the local 
domain,
references to classes in it should automatically be found.
You should only need to use the -Projects flag if you are making 
references to
uninstalled projects (or if the libObjective project has been installed 
in another location).

The -Projects flag is for references to uninstalled projects, and it 
takes a *dictionary*
as an argument, not a filename.  The dictionary contains (as keys) the 
paths to the
.igsdoc files of the uninstalled projects, and (as values) the paths to 
the directories
in which the uninstalled projects will eventually be installed.

Unless you have interdependencies between projects, the simplest way to 
do things
is to build documentation for dependent projects after installing the 
documentation
of the projects they depend upon, thus avoiding the need for the 
-Project flag.

> Another question: AGSHtml does not support <prjref> tags, are you 
planning to
> add support for them or not?

I think we are waiting for someone to volunteer to implement them :-)