digitalmars.D.announce - Harbored-mod (doc generator) 0.2: Cross-referencing, methods/fields no
- Kiith-Sa (33/33) Jan 31 2015 Harbored-mod (https://github.com/kiith-sa/harbored-mod) is a
- jklp (10/44) Jan 31 2015 Hello i get an error while trying to compile it on Win32, with
- Kiith-Sa (10/65) Jan 31 2015 Thanks for detecting the error/commit.
- jklp (2/5) Jan 31 2015 It's ok now, i confirm the fix.
- Rikki Cattermole (3/33) Jan 31 2015 Atleast on chrome win7 the font is absolutely awful.
- Rikki Cattermole (3/52) Jan 31 2015 Also any chance that it could output json to represent modules instead
- Kiith-Sa (8/11) Feb 01 2015 Very unlikely in near future, I've refactored *most* HTML writing
- Rikki Cattermole (2/5) Feb 01 2015 http://imgur.com/JvbjN9o
- Kiith-Sa (4/12) Feb 01 2015 Not sure why Windows interprets 'sans' as 'serif', but it should
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
Jan 31 2015
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.0Hello 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.
Jan 31 2015
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: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?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.0Hello 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.
Jan 31 2015
"jklp" <jklp nowhere.fi> 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.
Jan 31 2015
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.0Atleast on chrome win7 the font is absolutely awful. Otherwise, I LOVE!
Jan 31 2015
On 1/02/2015 1:02 p.m., Rikki Cattermole wrote:On 1/02/2015 4:31 a.m., Kiith-Sa wrote:Also any chance that it could output json to represent modules instead of html?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.0Atleast on chrome win7 the font is absolutely awful. Otherwise, I LOVE!
Jan 31 2015
Could you post a screenshot? I mostly just use the default "sans" which can result in any font being used based on the OS,Atleast on chrome win7 the font is absolutely awful.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.
Feb 01 2015
On 2/02/2015 2:36 a.m., Kiith-Sa wrote:http://imgur.com/JvbjN9oCould you post a screenshot? I mostly just use the default "sans" which can result in any font being used based on the OS,Atleast on chrome win7 the font is absolutely awful.
Feb 01 2015
On Sunday, 1 February 2015 at 13:40:29 UTC, Rikki Cattermole wrote:On 2/02/2015 2:36 a.m., Kiith-Sa wrote:Not sure why Windows interprets 'sans' as 'serif', but it should at least use sans (Verdana on Windows) now.http://imgur.com/JvbjN9oCould you post a screenshot? I mostly just use the default "sans" which can result in any font being used based on the OS,Atleast on chrome win7 the font is absolutely awful.
Feb 01 2015