Csound Csound-dev Csound-tekno Search About

[Csnd-dev] API docs

Date2017-02-01 08:39
FromVictor Lazzarini
Subject[Csnd-dev] API docs
I’ve added the build of API docs to cmake. So if you have doxygen, you should be able to
do 

$ make doc

and the documents will appear in docs in your build dir.
========================
Prof. Victor Lazzarini
Dean of Arts, Celtic Studies, and Philosophy,
Maynooth University,
Maynooth, Co Kildare, Ireland
Tel: 00 353 7086936

Date2017-02-01 10:04
FromRory Walsh
SubjectRe: [Csnd-dev] API docs
Nice addition Victor. Thanks. Btw, are the online docs http://csound.github.io/docs/api/index.html automatically generated?

On 1 February 2017 at 08:39, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote:
I’ve added the build of API docs to cmake. So if you have doxygen, you should be able to
do

$ make doc

and the documents will appear in docs in your build dir.
========================
Prof. Victor Lazzarini
Dean of Arts, Celtic Studies, and Philosophy,
Maynooth University,
Maynooth, Co Kildare, Ireland
Tel: 00 353 7086936
Fax: 00 353 1 7086952



Date2017-02-01 11:57
FromVictor Lazzarini
SubjectRe: [Csnd-dev] API docs
I don’t think so.
========================
Prof. Victor Lazzarini
Dean of Arts, Celtic Studies, and Philosophy,
Maynooth University,
Maynooth, Co Kildare, Ireland
Tel: 00 353 7086936
Fax: 00 353 1 7086952 

> On 1 Feb 2017, at 10:04, Rory Walsh  wrote:
> 
> Nice addition Victor. Thanks. Btw, are the online docs http://csound.github.io/docs/api/index.html automatically generated?
> 
> On 1 February 2017 at 08:39, Victor Lazzarini  wrote:
> I’ve added the build of API docs to cmake. So if you have doxygen, you should be able to
> do
> 
> $ make doc
> 
> and the documents will appear in docs in your build dir.
> ========================
> Prof. Victor Lazzarini
> Dean of Arts, Celtic Studies, and Philosophy,
> Maynooth University,
> Maynooth, Co Kildare, Ireland
> Tel: 00 35

Date2017-02-01 12:42
FromRory Walsh
SubjectRe: [Csnd-dev] API docs
That's a pity. The only time I ever posted doxygen docs on a github site I had to manually build and push each time. It was a pain. 

On 1 February 2017 at 11:57, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote:
I don’t think so.
========================
Prof. Victor Lazzarini
Dean of Arts, Celtic Studies, and Philosophy,
Maynooth University,
Maynooth, Co Kildare, Ireland
Tel: 00 353 7086936
Fax: 00 353 1 7086952

> On 1 Feb 2017, at 10:04, Rory Walsh <rorywalsh@ear.ie> wrote:
>
> Nice addition Victor. Thanks. Btw, are the online docs http://csound.github.io/docs/api/index.html automatically generated?
>
> On 1 February 2017 at 08:39, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote:
> I’ve added the build of API docs to cmake. So if you have doxygen, you should be able to
> do
>
> $ make doc
>
> and the documents will appear in docs in your build dir.
> ========================
> Prof. Victor Lazzarini
> Dean of Arts, Celtic Studies, and Philosophy,
> Maynooth University,
> Maynooth, Co Kildare, Ireland
> Tel: 00 353 7086936
> Fax: 00 353 1 7086952
>
>



Date2017-02-01 14:46
FromVictor Lazzarini
SubjectRe: [Csnd-dev] API docs
Since the build is now automated, I guess it should not think it would take much to complete this. Suggestions are welcome.
========================
Prof. Victor Lazzarini
Dean of Arts, Celtic Studies, and Philosophy,
Maynooth University,
Maynooth, Co Kildare, Ireland
Tel: 00 353 7086936
Fax: 00 353 1 7086952 

> On 1 Feb 2017, at 12:42, Rory Walsh  wrote:
> 
> That's a pity. The only time I ever posted doxygen docs on a github site I had to manually build and push each time. It was a pain. 
> 
> On 1 February 2017 at 11:57, Victor Lazzarini  wrote:
> I don’t think so.
> ========================
> Prof. Victor Lazzarini
> Dean of Arts, Celtic Studies, and Philosophy,
> Maynooth University,
> Maynooth, Co Kildare, Ireland
> Tel: 00 353 7086936
> Fax: 00 353 1 7086952
> 
> > On 1 Feb 2017, at 10:04, Rory Walsh  wrote:
> >
> > Nice addition Victor. Thanks. Btw, are the online docs http://csound.github.io/docs/api/index.html automatically generated?
> >
> > On 1 February 2017 at 08:39, Victor Lazzarini  wrote:
> > I’ve added the build of API docs to cmake. So if you have doxygen, you should be able to
> > do
> >
> > $ make doc
> >
> > and the documents will appear in docs in your build dir.
> > ========================
> > Prof. Victor Lazzarini
> > Dean of Arts, Celtic Studies, and Philosophy,
> > Maynooth University,
> > Maynooth, Co Kildare, Ireland
> > Tel: 00 353 7086936
> > Fax: 00 

Date2017-02-01 16:24
FromRory Walsh
SubjectRe: [Csnd-dev] API docs
Maybe Nate can help. I wonder if he is on this list though, he seems to hang out only on the github page?

On 1 February 2017 at 14:46, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote:
Since the build is now automated, I guess it should not think it would take much to complete this. Suggestions are welcome.
========================
Prof. Victor Lazzarini
Dean of Arts, Celtic Studies, and Philosophy,
Maynooth University,
Maynooth, Co Kildare, Ireland
Tel: 00 353 7086936
Fax: 00 353 1 7086952

> On 1 Feb 2017, at 12:42, Rory Walsh <rorywalsh@ear.ie> wrote:
>
> That's a pity. The only time I ever posted doxygen docs on a github site I had to manually build and push each time. It was a pain.
>
> On 1 February 2017 at 11:57, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote:
> I don’t think so.
> ========================
> Prof. Victor Lazzarini
> Dean of Arts, Celtic Studies, and Philosophy,
> Maynooth University,
> Maynooth, Co Kildare, Ireland
> Tel: 00 353 7086936
> Fax: 00 353 1 7086952
>
> > On 1 Feb 2017, at 10:04, Rory Walsh <rorywalsh@ear.ie> wrote:
> >
> > Nice addition Victor. Thanks. Btw, are the online docs http://csound.github.io/docs/api/index.html automatically generated?
> >
> > On 1 February 2017 at 08:39, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote:
> > I’ve added the build of API docs to cmake. So if you have doxygen, you should be able to
> > do
> >
> > $ make doc
> >
> > and the documents will appear in docs in your build dir.
> > ========================
> > Prof. Victor Lazzarini
> > Dean of Arts, Celtic Studies, and Philosophy,
> > Maynooth University,
> > Maynooth, Co Kildare, Ireland
> > Tel: 00 353 7086936
> > Fax: 00 353 1 7086952
> >
> >
>
>