Bug 9725

Summary: generated file header-list.html has invalid links
Product: [Retired] Red Hat Linux Reporter: Brock Organ <borgan>
Component: kdocAssignee: Preston Brown <pbrown>
Status: CLOSED WONTFIX QA Contact:
Severity: medium Docs Contact:
Priority: medium    
Version: 6.2   
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2000-02-24 02:37:36 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Brock Organ 2000-02-23 21:19:49 UTC
from the stock piglet beta:

[root@test95 idl]# kdoc --html -d /usr/share/idl/ -n foo
/usr/share/idl/*.idl

this creates html docs in the /usr/share/idl directory. Examine the
generated file header-list.html (output edited) and note the invalid links
to files like: "-usr-share-idl-FileManager-idl.html" which do not exist and
were not created by kdoc ...

[root@test95 idl]# more header-list.html
<HTML><HEAD>

 ... unimportant text removed ...

        <LI><A
HREF="-usr-share-idl-FileManager-idl.html">/usr/share/idl/FileManager.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-GnomeObject-idl.html">/usr/share/idl/GnomeObject.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-Gnumeric-idl.html">/usr/share/idl/Gnumeric.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-Table-idl.html">/usr/share/idl/Table.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-control--gcenter-idl.html">/usr/share/idl/control-center.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-desktop--geditor-idl.html">/usr/share/idl/desktop-editor.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-desktop--gtextviewer-idl.html">/usr/share/idl/desktop-textviewer.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-gnome--gfactory-idl.html">/usr/share/idl/gnome-factory.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-gnome--gpanel-idl.html">/usr/share/idl/gnome-panel.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-gnome--gpim-idl.html">/usr/share/idl/gnome-pim.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-gnome--gunknown-idl.html">/usr/share/idl/gnome-unknown.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-help--gbrowser-idl.html">/usr/share/idl/help-browser.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-magicdev-idl.html">/usr/share/idl/magicdev.idl</A></LI>
        <LI><A
HREF="-usr-share-idl-name--gservice-idl.html">/usr/share/idl/name-service.idl</A></LI>
</UL>
<HR>
        <table>
        <tr><td><small>Generated by: root.redhat.com on Wed Feb
23 16:27:16 200.</small></td></tr>
        </table>
</BODY>
</HTML>
[root@test95 idl]#

Comment 1 Preston Brown 2000-02-24 02:32:59 UTC
kdoc is most definitely not meant to document .idl files, only .h files from
C/C++.

Comment 2 Preston Brown 2000-02-24 02:37:59 UTC
ok, it's late, I lied, it is supposed to.  We won't fix this for 6.2, should be
fixed with the much better kdoc included with KDE 2, which will make 7.0.
Nobody uses kdoc on idl files right now anyway (luckily), only on C++ header
files.