Adding description for custom class/method in class browser

I tried as you said, didn't work.

I think the issue is in my xml file.

I have a project called GT50. In that project I've created a class "test1"

In the project folder I have my test1.cls and my GT50.xml

So I used you're exmple from pct to create the xml but I guess I'm not doing it right:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<unit packageName="" className="test1" isAbstract="true" isFinal="false" isInterface="false">

   <classComment>/*************************************************************/</classComment>

   <classComment>/* Copyright (c) 2011,2012 by Progress Software Corporation. */</classComment>

   <classComment>/*                                                           */</classComment>

   <classComment>/* All rights reserved.  No part of this program or document */</classComment>

   <classComment>/* may be  reproduced in  any form  or by  any means without */</classComment>

   <classComment>/* permission in writing from Progress Software Corporation. */</classComment>

   <classComment>/*************************************************************/</classComment>

   <classComment>/** ------------------------------------------------------------------------&#xD;

   Purpose     : Default implementation of IDataAdminContext    &#xD;

   Syntax      : &#xD;

   Description : &#xD;

   Author(s)   : hdaniels&#xD;

   Created     : Sat Aug 07 16:54:55 EDT 2010&#xD;

   Notes       : implements IDataAdminModel &#xD;

 ----------------------------------------------------------------------*/</classComment>

   <classComment>/** default implementation IDataAdminContextData implements IDataAdminModel */</classComment>  

</unit>

Thanks for your answer.

That XML document that you're showing here looks like a result of the PCT ClassDocumentation target. That's the Input for the XMLDocumentation task: github.com/.../XmlDocumentation

The output of the XMLDocumentation is a single XML file that provides the comments for the class browser.

The link that the github entry refers to does not work :(

www.pugchallenge.eu/.../emea_pug_challenge_2013_smartdox.pdf

I have logged a documentation issue. The missing PDF is attached to the ticket:

github.com/.../167

At first, my question was more about the structure of that xml document. For some reason I can't/won't use PCT, just needed how to link the xml document with all my classes documentation (and how it should looks like) with my custom classes of my project.

Thanks for your time!

AFIAK Progress never formally published the structure. So it's undocumented. So the best guess would be to look at the results of the PCT job or com\openedge\pdt\text\objectbrowser\OpenEdge.xml within the %DLC%\oeide\plugins\com.openedge.pdt.text_11.6.2.00\progresside.jar archive.

[quote user="asp_progi"]

For some reason I can't/won't use PCT

[/quote]

What a weird reason !

We finally decided that PCT is the best way for generates our doc.

I just hope that I won't have too much trouble seting up PCT...

Thanks again for help.