Documentation generator is not working

Sep 02, 2021

Vinod K Chandran

Sep 02, 2021

jfondren

Sep 02, 2021

Sep 02, 2021

Sep 02, 2021

Sep 03, 2021

Sep 05, 2021

Sep 06, 2021

Sep 06, 2021

import std.stdio : log = writeln; void main() { log("Experimenting with dDoc"); } /// A sample function. /// Let's check what we will get in documentation. /// abc - A simple string void sample(string abc) {log(abc);}

September 02, 2021

Re: Documentation generator is not working

Posted by jfondren
in reply to Vinod K Chandran

Permalink

jfondren

Posted in reply to Vinod K Chandran

Permalink

On Thursday, 2 September 2021 at 16:20:32 UTC, Vinod K Chandran wrote:

Hi all,
I am playing with ddoc. I wrote this code--

import std.stdio : log = writeln;

void main() {
    log("Experimenting with dDoc");
}

/// A sample function.
/// Let's check what we will get in documentation.
/// abc - A simple string
void sample(string abc) {log(abc);}

And then, compile it with "-D" switch. At first, I saw an html file is generated. But I deleted it and compiled again. This time, no html file is generated. What's wrong with this ?

What commands are you running? What you describe doing, works:

$ cat file.d
import std.stdio : log = writeln;

void main() {
        log("Experimenting with dDoc");
}

/// A sample function.
/// Let's check what we will get in documentation.
/// abc - A simple string
void sample(string abc) {log(abc);}

$ dmd -D file

$ w3m -dump file.html|grep -A1 function
    A sample function. Let's check what we will get in documentation. abc - A
    simple string

$ rm -fv file.html
removed 'file.html'

$ dmd -D file

$ w3m -dump file.html|grep -A1 function
    A sample function. Let's check what we will get in documentation. abc - A
    simple string
$

$ dmd -D file $ w3m -dump file.html|grep -A1 function A sample function. Let's check what we will get in documentation. abc - A simple string $ rm -fv file.html removed 'file.html' $ dmd -D file $ w3m -dump file.html|grep -A1 function A sample function. Let's check what we will get in documentation. abc - A simple string $

On Thursday, 2 September 2021 at 17:34:59 UTC, Adam D Ruppe wrote: > > Anything after -run goes to your program not the compiler. > > Args to the compiler must be before -run. Thanks for the reply. Got the point now. :)

On 9/2/21 10:38 AM, Vinod K Chandran wrote: > On Thursday, 2 September 2021 at 17:34:59 UTC, Adam D Ruppe wrote: >> >> Anything after -run goes to your program not the compiler. >> >> Args to the compiler must be before -run. > > Thanks for the reply. Got the point now. :) > So, change your program to respond to -D and generate the documentation potentially by spawning a dmd instance. :o) Ali

On Friday, 3 September 2021 at 20:21:43 UTC, Ali Çehreli wrote: > > So, change your program to respond to -D and generate the documentation potentially by spawning a dmd instance. :o) > > I am not sure i get the point correctly. You mean, starting dmd as a new process from my program and pass the file name as parameter ?

On 9/5/21 3:22 PM, Vinod K Chandran wrote: > On Friday, 3 September 2021 at 20:21:43 UTC, Ali Çehreli wrote: >> >> So, change your program to respond to -D and generate the documentation potentially by spawning a dmd instance. :o) >> >> > I am not sure i get the point correctly. You mean, starting dmd as a new process from my program and pass the file name as parameter ? Yes, but it was meant to be a joke. Don't do that. :) Ali

Forums