For anyone that might be interested, I've created a Windows CHM help file based on the Tango 0.99.4 source code.

The CHM help file can be downloaded from here:

http://www.zeusedit.com/forum/viewtopic.php?t=1572

Cheers Jussi

Jussi Jumppanen <jussij@zeusedit.com> wrote:

> For anyone that might be interested, I've created
> a Windows CHM help file based on the Tango 0.99.4
> source code.
>
> The CHM help file can be downloaded from here:
>
> http://www.zeusedit.com/forum/viewtopic.php?t=1572
>
> Cheers Jussi
>

It seems to use C++ namespace separators (::), which might be confusing.

Jussi Jumppanen wrote:
> For anyone that might be interested, I've created a Windows CHM help file based on the Tango 0.99.4 source code.
> 
> The CHM help file can be downloaded from here:
> 
> http://www.zeusedit.com/forum/viewtopic.php?t=1572
> 
> Cheers Jussi
> 

What software did you use to create the chm? I've experimented with a chm builder for putting together the Tango reference manual, but it was quite buggy.  Any recommendations?

-JJR

John Reimer Wrote:

> What software did you use to create the chm?

> What software did you use to create the chm?

I used the command line help compiler that comes with the Microsoft HTML Workshop:

   http://msdn2.microsoft.com/en-us/library/ms670169.aspx

The process in a nutshell is:

  1) Run doxygen against the source code to produce the HTML
  2) Run the help compiler to convert the HTML to CHM

The Zeus IDE has a feature to semi-automate the process:

    http://www.zeusedit.com/forum/viewtopic.php?p=619

but it is broken in the current release :(

It just so happened that I used the Tango source code as
a test case to help fix this current Zeus bug.

Cheers Jussi

Simen Kjaeraas Wrote:

> It seems to use C++ namespace separators (::), which might be confusing.

This would be the result of a bug in doxygen:

http://www.stack.nl/~dimitri/doxygen/

It is the tool that created the HTML documentation.

Cheers Jussi

Jussi Jumppanen wrote:
> For anyone that might be interested, I've created a Windows CHM help file based on the Tango 0.99.4 source code.
> 
> The CHM help file can be downloaded from here:
> 
> http://www.zeusedit.com/forum/viewtopic.php?t=1572
> 
> Cheers Jussi
> 

Loads better than anything Descent could come up with. Thanks for this.

Yeah, this is great stuff, and major judos to Jussi.

However, dOxygen fails miserably at some thing because you just can't treat D like C. One of the more tricky aspects are "version" blocks, which often result in half or more of the API going AWOL :)

Mango used dOxygen for a couple of years, yet we went with ddoc for Tango in order to avoid that problem. As a result, we exchanged that problem for a lack of cross-module links, releationship diagrams, and various other things. There's a gaping hole here for someone to fill.

- Kris


"Robert Fraser" <fraserofthenight@gmail.com> wrote in message news:fnpjp2$2juh$1@digitalmars.com...
> Jussi Jumppanen wrote:
>> For anyone that might be interested, I've created a Windows CHM help file based on the Tango 0.99.4 source code.
>>
>> The CHM help file can be downloaded from here:
>>
>> http://www.zeusedit.com/forum/viewtopic.php?t=1572
>>
>> Cheers Jussi
>>
>
> Loads better than anything Descent could come up with. Thanks for this.

er, Kudos :)


"Kris" <foo@bar.com> wrote in message news:fnqa2r$1a5r$1@digitalmars.com...
> Yeah, this is great stuff, and major judos to Jussi.
>
> However, dOxygen fails miserably at some thing because you just can't treat D like C. One of the more tricky aspects are "version" blocks, which often result in half or more of the API going AWOL :)
>
> Mango used dOxygen for a couple of years, yet we went with ddoc for Tango in order to avoid that problem. As a result, we exchanged that problem for a lack of cross-module links, releationship diagrams, and various other things. There's a gaping hole here for someone to fill.
>
> - Kris
>
>
> "Robert Fraser" <fraserofthenight@gmail.com> wrote in message news:fnpjp2$2juh$1@digitalmars.com...
>> Jussi Jumppanen wrote:
>>> For anyone that might be interested, I've created a Windows CHM help file based on the Tango 0.99.4 source code.
>>>
>>> The CHM help file can be downloaded from here:
>>>
>>> http://www.zeusedit.com/forum/viewtopic.php?t=1572
>>>
>>> Cheers Jussi
>>>
>>
>> Loads better than anything Descent could come up with. Thanks for this.
>
> 

Kris wrote:

> However, dOxygen fails miserably at some thing because you just can't treat D like C. One of the more tricky aspects are "version" blocks, which often result in half or more of the API going AWOL :)
> 
> Mango used dOxygen for a couple of years, yet we went with ddoc for Tango in order to avoid that problem. As a result, we exchanged that problem for a lack of cross-module links, releationship diagrams, and various other things. There's a gaping hole here for someone to fill.

I've used both of Doxygen and Ddoc for writing D embedded documentation,
the current solution is to use ddoc-style and a doxygen preprocessor...

Works "OK" for basic stuff (functions/parameters), without versions etc.
Translates e.g. "Params:" into "\param", and "See_Also:" into "\see"...

--anders