Jump to page: 1 2
Thread overview
Revamp of CandyDOC
Apr 11, 2012
Eldar Insafutdinov
Apr 11, 2012
Andrej Mitrovic
Apr 12, 2012
Jonas Drewsen
Apr 12, 2012
Jordi Sayol
Apr 13, 2012
Jacob Carlborg
Apr 13, 2012
Jonas Drewsen
Apr 13, 2012
Eldar Insafutdinov
Apr 13, 2012
Robert Clipsham
Apr 13, 2012
Mirko Pilger
Apr 13, 2012
Jacob Carlborg
Apr 11, 2012
Jordi Sayol
Apr 12, 2012
Jacob Carlborg
Apr 12, 2012
Brad Anderson
Apr 12, 2012
a
Apr 12, 2012
Jay Norwood
Apr 12, 2012
Jordi Sayol
Apr 13, 2012
Ary Manzana
April 11, 2012
CandyDOC has not been updated for about 6 years, and despite its usefulness its current state was rather sad. Overall look was awful; colours, font sizes, everything just was not right. D allows some very beautiful code, but the look and feel of documentation is not on par. Anyway, I gave it a bit of a refresh (which was in fact a major refactoring) and here is an example http://eldar.me/candydoc/algorithm.html . Among new features is also instant filtering. You can grab the sources at https://github.com/eldar/candydoc . There is still a scope for improvements: adding links to the subsections and ideally producing links to the source code. For that ddoc needs to output line numbers of declarations which I am not sure it does, but that can be added.

Cheers

Eldar
April 11, 2012
On 4/12/12, Eldar Insafutdinov <e.insafutdinov@gmail.com> wrote:
> There is still a scope for
> improvements

Also: Not jumping to the Outline pane every time a different package is selected (OR it should memorize the position of the scrollbar). This is especially annoying in e.g. gtkd: http://gtkd.mikewey.eu/src/cairo/Surface.html Whenever I click on another package it jumps to the outline view, and if I go back I can't figure out where I was because the scrollbar resets.

Othe than that your improvements look very nice!
April 11, 2012
Al 12/04/12 00:17, En/na Eldar Insafutdinov ha escrit:
> CandyDOC has not been updated for about 6 years, and despite its usefulness its current state was rather sad. Overall look was awful; colours, font sizes, everything just was not right. D allows some very beautiful code, but the look and feel of documentation is not on par. Anyway, I gave it a bit of a refresh (which was in fact a major refactoring) and here is an example http://eldar.me/candydoc/algorithm.html . Among new features is also instant filtering. You can grab the sources at https://github.com/eldar/candydoc . There is still a scope for improvements: adding links to the subsections and ideally producing links to the source code. For that ddoc needs to output line numbers of declarations which I am not sure it does, but that can be added.
> 
> Cheers
> 
> Eldar
> 

Another important thing is to allow multiple directories. Lars T. Kyllingstad has a corrected version of candydoc at https://github.com/kyllingstad/scid that allow this.
In Your project, simply replacing "path[i]" by "path.join("_")" on explorer.js(236), and naming html files like path_to_file.html

Best regards,
-- 
Jordi Sayol
April 12, 2012
On 2012-04-12 00:17, Eldar Insafutdinov wrote:
> CandyDOC has not been updated for about 6 years, and despite its
> usefulness its current state was rather sad. Overall look was awful;
> colours, font sizes, everything just was not right. D allows some very
> beautiful code, but the look and feel of documentation is not on par.
> Anyway, I gave it a bit of a refresh (which was in fact a major
> refactoring) and here is an example
> http://eldar.me/candydoc/algorithm.html . Among new features is also
> instant filtering. You can grab the sources at
> https://github.com/eldar/candydoc . There is still a scope for
> improvements: adding links to the subsections and ideally producing
> links to the source code. For that ddoc needs to output line numbers of
> declarations which I am not sure it does, but that can be added.
>
> Cheers
>
> Eldar

Cool.

-- 
/Jacob Carlborg
April 12, 2012
On Wed, Apr 11, 2012 at 4:17 PM, Eldar Insafutdinov < e.insafutdinov@gmail.com> wrote:

> CandyDOC has not been updated for about 6 years, and despite its usefulness its current state was rather sad. Overall look was awful; colours, font sizes, everything just was not right. D allows some very beautiful code, but the look and feel of documentation is not on par. Anyway, I gave it a bit of a refresh (which was in fact a major refactoring) and here is an example http://eldar.me/candydoc/** algorithm.html <http://eldar.me/candydoc/algorithm.html> . Among new features is also instant filtering. You can grab the sources at https://github.com/eldar/**candydoc <https://github.com/eldar/candydoc> . There is still a scope for improvements: adding links to the subsections and ideally producing links to the source code. For that ddoc needs to output line numbers of declarations which I am not sure it does, but that can be added.
>
> Cheers
>
> Eldar
>

Looks really good.  Nice work.

Regards,
Brad Anderson


April 12, 2012
On Wednesday, 11 April 2012 at 22:34:40 UTC, Andrej Mitrovic wrote:
> On 4/12/12, Eldar Insafutdinov <e.insafutdinov@gmail.com> wrote:
>> There is still a scope for
>> improvements
>
> Also: Not jumping to the Outline pane every time a different package
> is selected (OR it should memorize the position of the scrollbar).
> This is especially annoying in e.g. gtkd:
> http://gtkd.mikewey.eu/src/cairo/Surface.html Whenever I click on
> another package it jumps to the outline view, and if I go back I can't
> figure out where I was because the scrollbar resets.
>
> Othe than that your improvements look very nice!

The outline and package panes should be combined IMHO. Perhaps something like (ascii art):

---------------
+
  atk
    Component
---------------
MyClass
  getStruct
  contains
  ...
  ...
FooClass
  setBar
  ...
---------------


Where clicking on atk would show all atk packages. Clicking on + show all packages etc.

The lower section is simply showing the currenly selected package.

/Jonas


April 12, 2012
This looks really nice.
April 12, 2012
Al 12/04/12 22:53, En/na Jonas Drewsen ha escrit:
> 
> The outline and package panes should be combined IMHO. Perhaps something like (ascii art):
> 
> ---------------
> +
>   atk
>     Component
> ---------------
> MyClass
>   getStruct
>   contains
>   ...
>   ...
> FooClass
>   setBar
>   ...
> ---------------
> 
> 
> Where clicking on atk would show all atk packages. Clicking on + show all packages etc.
> 
> The lower section is simply showing the currenly selected package.

I'm agree with you, but this is a deep rebuilding. First step is to separate left pane into a single file, and this will also drastically reduce the total size. Actually, every html package file contains all the left pane (unnecessarily repeated).

BTW, It looks very nice now. Thanks!

Best regards,
-- 
Jordi Sayol
April 12, 2012
On Wednesday, 11 April 2012 at 22:17:16 UTC, Eldar Insafutdinov wrote:
> example http://eldar.me/candydoc/algorithm.html . Among new


The outline panel links work fine on Google Chrome, but not on IE8.
April 12, 2012
Al 13/04/12 00:14, En/na Jay Norwood ha escrit:
> On Wednesday, 11 April 2012 at 22:17:16 UTC, Eldar Insafutdinov wrote:
>> example http://eldar.me/candydoc/algorithm.html . Among new
> 
> 
> The outline panel links work fine on Google Chrome, but not on IE8.
> 

Also properly works on Firefox 11 (Linux), and is a mess on IE6 on W2K.

-- 
Jordi Sayol
« First   ‹ Prev
1 2