Re: [Pdfdoclet-devel] Good-bye frame maker

[Ry4an B. <ry4...@ry...>]

On Wed, Oct 29, 2003 at 03:30:08PM -0800, Marcel Schoen wrote:
> > 1. Is there a way to control the order of the
> > packages in the finished
> >    document?  
> 
> Well, there wasn't until about one hour ago. Because
> so far I didn't really care too much. But after
> receiving your mail, I thought I might look into it.
> Well, thanks to some late contributions of some other
> guy (which allowed to create javadoc for single
> classes as well), it was very easy to solve. I just
> had to change one single word in the sourcecode (from
> "HashMap" to "TreeMap" :-)) Now the packages are
> sorted alphabetically.

Sorted alphabetically is nice, but control is what I was really seeking.
It would be nice to be able to specify the order in which they're to be
displayed.  If you're using a TreeMap the addition might be as simple as
passing into the TreeMap constructor a customer comparitor like this:

new TreeMap(new Comparator() {
    public int compare(Object packageName1, Object packageName2) {
        String packageOrder = WhereEverYouGetSettings.get("sort.order")
            + ",";
        int retval = packageOrder.indexOf(packageName1 + ",",
            packageName2 + ",");
        return (retval != 0)
            ? retval
            : ((String)pacakgeName1).compareTo(pacakgeName2);
    }
});

Assuming a comma separated list of packages was available to specify
sort order, that would put the packages in the specified order if
they're present in the order speficification string or in alphabetical
order at the start of the list if they're not.  At least my quick 'n'
dirty mental email compiler tells me it would. :)


> > 2. My internal links aren't working and I can't
> > figure out why.  I've
> >    attached my build.xml and its output.  I'm pretty
> > sure the @see
> >    syntax is correct as the links work w/ Sun's
> > default doclet.
> 
> I think I'm missing something here. What do your @see
> tags look like, exactly? Maybe you can send me an
> example .java sourcefile. Or the entire source, if you
> want, so I can try to reproduce the problem.

I've attached a tarball which contains the source for two classes, the
resulting .pdf (from 0.5.1), and my configuration properties file.  It
looks to me that RangeSet's parse method should have a link to the Range
class in it's @see clause, but it's not showing up.  Did I do something
stupid and negelect to turn links on somewhere?  I'm invoking the doclet
with an ant call that looks like this:

      <javadoc
        docletpathref="dockletpath"
        classpathref="classes"
        doclet="com.tarsec.javadoc.pdfdoclet.PDFDoclet"
        additionalparam
          ="-pdf ../technical/UserGuides/WebRaidAPI.pdf -debug -config config-pdfdoclet.properties"
        public="true"
        protected="false"
        private="false"
      >
        <fileset dir="../../Common/src/" includesfile="include-src"/>
        <fileset dir="../../WebRAID/src/" includesfile="include-src"/>
        <fileset dir="../../WebRAIDUtil/src/" includesfile="include-src"/>
      </javadoc>
      <echo
        message="created Documentation/technical/UserGuides/WebRaidAPI.pdf"/>
    </target>

I know the config-pdfdoclet.properties file is getting read as the title
shows up correctly.

Lastly, I entered a bug wherein summary blocks have the same parameter
name for all parameters.
http://sourceforge.net/tracker/index.php?func=detail&aid=833186&group_id=55507&atid=477255

I might be able to help out with these this weekend if you decide that
explict package ordering is something good and/or are able to reproduce
that bug.

Thanks again for a great little app,

-- 
Ry4an Brase - http://ry4an.org                                    /~\
'If you're not a rebel when you're 20 you've got no heart; if     \ /
 you're not establishment when you're 30 you've got no brain.'     X
             Join the ASCII ribbon campaign against HTML email    / \