Thread overview | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
January 31, 2015 Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files | ||||
---|---|---|---|---|
| ||||
Harbored-mod (https://github.com/kiith-sa/harbored-mod) is a documentation generator based on Brian Schott's Harbored that supports both DDoc and Markdown in documentation comments. -------------------------- Examples of generated docs -------------------------- * Public imports in a package.d: http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity.html * Class with a template parameter, member functions and aliases: http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/entitymanager/EntityManager.html * Simple DDoc See_Also: section: http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/componenttypeinfo/ImmutableRawComponent.html * Note: DDoc section with some markdown: http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/processtypeinfo.html#prioritizeProcessOverloads ------------------ Release highlights ------------------ * Automatic cross-referencing in code blocks and inline code * New (and now default) output format: "aggregated" HTML; generate documentation files only for aggregates (modules, structs, classes, etc.) and document non-aggregate members (functions, variables, etc.) in these files. The previous, DDox compatible format, where a separate file is generated for every symbol, is still supported through the `--format=html-simple` option. * Various style and usability improvements * Major refactoring * Many bugfixes Full changelog: https://github.com/kiith-sa/harbored-mod/releases/tag/v0.2.0 |
January 31, 2015 Re: Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | On Saturday, 31 January 2015 at 15:31:37 UTC, Kiith-Sa wrote: > Harbored-mod (https://github.com/kiith-sa/harbored-mod) is a > documentation generator based on Brian Schott's Harbored that > supports both DDoc and Markdown in documentation comments. > > -------------------------- > Examples of generated docs > -------------------------- > > * Public imports in a package.d: > http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity.html > * Class with a template parameter, member functions and aliases: > http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/entitymanager/EntityManager.html > * Simple DDoc See_Also: section: > http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/componenttypeinfo/ImmutableRawComponent.html > * Note: DDoc section with some markdown: > http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/processtypeinfo.html#prioritizeProcessOverloads > > > ------------------ > Release highlights > ------------------ > > * Automatic cross-referencing in code blocks and inline code > > * New (and now default) output format: "aggregated" HTML; > generate documentation files only for aggregates (modules, > structs, classes, etc.) and document non-aggregate members > (functions, variables, etc.) in these files. > > The previous, DDox compatible format, where a separate file > is generated for every symbol, is still supported through > the `--format=html-simple` option. > > * Various style and usability improvements > * Major refactoring > * Many bugfixes > > > Full changelog: > https://github.com/kiith-sa/harbored-mod/releases/tag/v0.2.0 Hello i get an error while trying to compile it on Win32, with dmd 2066.1: Error 42: Symbol Undefined _D3std5array40__T5emptyTE14symboldatabase10SymbolTypeZ5emptyFNaNbNdNiNfxAE14symboldatabase10SymbolTypeZb demangled: pure nothrow @property @nogc @safe bool std.array.empty!(symboldatabase.SymbolType).empty(const(symboldatabase.SymbolType[])) the error only happend since commit 05ab80052d1b7d1dc3b1ff38c30addd9df7f3db4 otherwise thx for this nice software. |
January 31, 2015 Re: Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files | ||||
---|---|---|---|---|
| ||||
Posted in reply to jklp | On Saturday, 31 January 2015 at 17:43:49 UTC, jklp wrote: > On Saturday, 31 January 2015 at 15:31:37 UTC, Kiith-Sa wrote: >> Harbored-mod (https://github.com/kiith-sa/harbored-mod) is a >> documentation generator based on Brian Schott's Harbored that >> supports both DDoc and Markdown in documentation comments. >> >> -------------------------- >> Examples of generated docs >> -------------------------- >> >> * Public imports in a package.d: >> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity.html >> * Class with a template parameter, member functions and aliases: >> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/entitymanager/EntityManager.html >> * Simple DDoc See_Also: section: >> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/componenttypeinfo/ImmutableRawComponent.html >> * Note: DDoc section with some markdown: >> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/processtypeinfo.html#prioritizeProcessOverloads >> >> >> ------------------ >> Release highlights >> ------------------ >> >> * Automatic cross-referencing in code blocks and inline code >> >> * New (and now default) output format: "aggregated" HTML; >> generate documentation files only for aggregates (modules, >> structs, classes, etc.) and document non-aggregate members >> (functions, variables, etc.) in these files. >> >> The previous, DDox compatible format, where a separate file >> is generated for every symbol, is still supported through >> the `--format=html-simple` option. >> >> * Various style and usability improvements >> * Major refactoring >> * Many bugfixes >> >> >> Full changelog: >> https://github.com/kiith-sa/harbored-mod/releases/tag/v0.2.0 > > Hello i get an error while trying to compile it on Win32, with dmd 2066.1: > > Error 42: Symbol Undefined _D3std5array40__T5emptyTE14symboldatabase10SymbolTypeZ5emptyFNaNbNdNiNfxAE14symboldatabase10SymbolTypeZb > > demangled: pure nothrow @property @nogc @safe bool std.array.empty!(symboldatabase.SymbolType).empty(const(symboldatabase.SymbolType[])) > > the error only happend since commit 05ab80052d1b7d1dc3b1ff38c30addd9df7f3db4 > > otherwise thx for this nice software. Thanks for detecting the error/commit. Unfortunately I have no way to test on Win32 currently, and on Linux (32 or 64) I couldn't reproduce this (and AFAIK Mac build works as well), but based on the demangled name I tried to blindly fix a possible cause. That said, there is no "obvious" cause; I suspect this may be a Win32-specific linker error. Could you clone the current git master (https://github.com/kiith-sa/harbored-mod.git) and try if it works? |
January 31, 2015 Re: Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | On Saturday, 31 January 2015 at 18:47:28 UTC, Kiith-Sa wrote:
> Could you clone the current git master (https://github.com/kiith-sa/harbored-mod.git) and try if it works?
It's ok now, i confirm the fix.
|
February 01, 2015 Re: Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | On 1/02/2015 4:31 a.m., Kiith-Sa wrote:
> Harbored-mod (https://github.com/kiith-sa/harbored-mod) is a
> documentation generator based on Brian Schott's Harbored that
> supports both DDoc and Markdown in documentation comments.
>
> --------------------------
> Examples of generated docs
> --------------------------
>
> * Public imports in a package.d:
> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity.html
> * Class with a template parameter, member functions and aliases:
> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/entitymanager/EntityManager.html
>
> * Simple DDoc See_Also: section:
> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/componenttypeinfo/ImmutableRawComponent.html
>
> * Note: DDoc section with some markdown:
> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/processtypeinfo.html#prioritizeProcessOverloads
>
>
>
> ------------------
> Release highlights
> ------------------
>
> * Automatic cross-referencing in code blocks and inline code
>
> * New (and now default) output format: "aggregated" HTML;
> generate documentation files only for aggregates (modules,
> structs, classes, etc.) and document non-aggregate members
> (functions, variables, etc.) in these files.
>
> The previous, DDox compatible format, where a separate file
> is generated for every symbol, is still supported through
> the `--format=html-simple` option.
>
> * Various style and usability improvements
> * Major refactoring
> * Many bugfixes
>
>
> Full changelog:
> https://github.com/kiith-sa/harbored-mod/releases/tag/v0.2.0
Atleast on chrome win7 the font is absolutely awful.
Otherwise, I LOVE!
|
February 01, 2015 Re: Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files | ||||
---|---|---|---|---|
| ||||
Posted in reply to Rikki Cattermole | On 1/02/2015 1:02 p.m., Rikki Cattermole wrote:
> On 1/02/2015 4:31 a.m., Kiith-Sa wrote:
>> Harbored-mod (https://github.com/kiith-sa/harbored-mod) is a
>> documentation generator based on Brian Schott's Harbored that
>> supports both DDoc and Markdown in documentation comments.
>>
>> --------------------------
>> Examples of generated docs
>> --------------------------
>>
>> * Public imports in a package.d:
>> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity.html
>> * Class with a template parameter, member functions and aliases:
>> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/entitymanager/EntityManager.html
>>
>>
>> * Simple DDoc See_Also: section:
>> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/componenttypeinfo/ImmutableRawComponent.html
>>
>>
>> * Note: DDoc section with some markdown:
>> http://defenestrate.eu/docs/tharsis-core/api/tharsis/entity/processtypeinfo.html#prioritizeProcessOverloads
>>
>>
>>
>>
>> ------------------
>> Release highlights
>> ------------------
>>
>> * Automatic cross-referencing in code blocks and inline code
>>
>> * New (and now default) output format: "aggregated" HTML;
>> generate documentation files only for aggregates (modules,
>> structs, classes, etc.) and document non-aggregate members
>> (functions, variables, etc.) in these files.
>>
>> The previous, DDox compatible format, where a separate file
>> is generated for every symbol, is still supported through
>> the `--format=html-simple` option.
>>
>> * Various style and usability improvements
>> * Major refactoring
>> * Many bugfixes
>>
>>
>> Full changelog:
>> https://github.com/kiith-sa/harbored-mod/releases/tag/v0.2.0
>
> Atleast on chrome win7 the font is absolutely awful.
> Otherwise, I LOVE!
Also any chance that it could output json to represent modules instead of html?
|
February 01, 2015 Re: Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files | ||||
---|---|---|---|---|
| ||||
Posted in reply to Rikki Cattermole | >> Atleast on chrome win7 the font is absolutely awful. Could you post a screenshot? I mostly just use the default "sans" which can result in any font being used based on the OS, > > Also any chance that it could output json to represent modules instead of html? Very unlikely in near future, I've refactored *most* HTML writing code but the rest would still need a lot of work, and then there'd be a non-trivial chunk of "HTMLWriter" code to rewrite (1k lines), which would likely result in finding finding more deficencies in separation of HTML writing from the rest of the code. |
February 01, 2015 Re: Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | On 2/02/2015 2:36 a.m., Kiith-Sa wrote: > >>> Atleast on chrome win7 the font is absolutely awful. > > Could you post a screenshot? I mostly just use the default "sans" which > can result in any font being used based on the OS, http://imgur.com/JvbjN9o |
February 01, 2015 Re: Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no longer in separate files | ||||
---|---|---|---|---|
| ||||
Posted in reply to Rikki Cattermole | On Sunday, 1 February 2015 at 13:40:29 UTC, Rikki Cattermole wrote:
> On 2/02/2015 2:36 a.m., Kiith-Sa wrote:
>>
>>>> Atleast on chrome win7 the font is absolutely awful.
>>
>> Could you post a screenshot? I mostly just use the default "sans" which
>> can result in any font being used based on the OS,
>
> http://imgur.com/JvbjN9o
Not sure why Windows interprets 'sans' as 'serif', but it should at least use sans (Verdana on Windows) now.
|
Copyright © 1999-2021 by the D Language Foundation