My favorites | Sign in
Logo
waf
Project hosting will be READ-ONLY Wednesday, 7AM PST due to brief network maintenance
                
New issue | Search
for
| Advanced search | Search tips
Issue 507: Add support for valadoc
1 person starred this issue and may be notified of changes. Back to list
Status:  Assigned
Owner:  ----
Type-Enhancement


Sign in to add a comment
 
Reported by gege2061, Aug 17, 2009
The attached file is a new task for generate the vala API documentation
with valadoc: http://live.gnome.org/Valadoc

Some improvements needed:

  * The function find_source_in_dir doesn't work (I'm not an expert in the
waf api)
  * The output dir must be an absolute patch

Usage example:
http://code.google.com/p/valide/source/browse/trunk/doc/wscript_build
Comment 1 by tnagy1024, Aug 17, 2009
The following is now the default idiom:
bld.path.ant_glob('**/*.c')
Status: Assigned
Labels: -Type-Other Type-Enhancement
Comment 2 by gege2061, Aug 17, 2009
This doesn't not fix my problems.

First, the ant_glob function doesn't accept the files in another directory (wscript
is in doc/ and sources in libvalide/).

Second, if I moved wscript in libvalide/, the paths are relative to current directory
(libvalide) and the task runs in the root directory. Maybe a lack of knowledge of the
API.
Comment 3 by tnagy1024, Aug 17, 2009
bld.path.find_dir('../libvalide').ant_glob('**/*.c')

the tasks are always executed from the build directory by default - except if told
otherwise (read the book)

node objects (returned by ant_glob with flat=False) may be converted to whatever
relative path or absolute path needed.


Comment 4 by gege2061, Aug 17, 2009
Thank's, that works fine.
valadoc.py
3.6 KB Download
Comment 5 by tnagy1024, Sep 12, 2009
Ok, but we need a demo folder. From the file i cannot guess what the outputs are.
Also, what is that doc usually used for? is it packaged in a tar file and uploaded to
a website for example?

Comment 6 by gege2061, Sep 12, 2009
> Ok, but we need a demo folder. From the file i cannot guess what the outputs are.

I have rewrote the playground doxy example in Vala.

> Also, what is that doc usually used for? is it packaged in a tar file and uploaded to
a website for example?

Exactly.
valadoc.tar.gz
196 KB Download
Comment 7 by tnagy1024, Sep 20, 2009
I have added the example to playground, it is being reviewed.
Sign in to add a comment

Hosted by Google Code