[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-kdoc
Subject:    kdoc bugs
From:       Benjamin Geer <benjamin.geer () mindspring ! com>
Date:       1999-11-07 9:57:13
[Download RAW message or body]

I've just tried to send mail to kdoc@kde.org, but it bounced from
MAILER-DAEMON@lift.ph.unimelb.edu.au ("no valid recipients were found").  Is
KDOC still being developed?

If so, here are a few bugs:

1.

template<class L> class EventMulticaster {
public:
    template<class E> void sendEvent(const E& event, void (L::* pm)(const
E&)) const {
    // ...
    }
};

This produces the following HTML ("(const E&))" is missing):

<A NAME=sendEvent></A><A NAME=ref6></A><table width="100%"><tr
bgcolor="#eeeeee"><td><strong>template&lt;class E&gt; void  <b>sendEvent</b>
(const E&amp; event, void (L::* pm) </strong></td></tr></table>
<small>[const]</small></p>

2.

template<class T> class Handle {
public:
    T* operator->() const {
    // ...
    }
};

This produces the following HTML:

<A NAME=operator->></A><A NAME=ref12></A><table width="100%"><tr
bgcolor="#eeeeee"><td><strong>T*  <b>operator-&gt;</b> ()
</strong></td></tr></table> <small>[const]</small></p><p>

Since the right angle bracket in the NAME property of the first anchor isn't
quoted or escaped, the browser interprets the second '>' as text: 

>
T* operator-> () 
[const]

3.

All our classes are in a namespace called "ucppkit", which has its own doc
comment.  KDOC produces a page called ucppkit.html, which lists everything
in the namespace (classes, using-declarations, and functions), in random
order.  At the top of this page is a line that says, "Definition #include
<osdep.hpp>", for no apparent reason.  (osdep.hpp is alphabetically the last
file that's passed to kdoc to generate the docs.)  Since the classes in the
namespace are defined in many different header files, it doesn't make sense
to mention one particular header file on that page.

Cheers,
Ben

[prev in list] [next in list] [prev in thread] [next in thread]