Enabled errors on warnings for the apidoc generation

This commit is contained in:
Thomas Nagy 2015-04-26 21:00:15 +02:00
parent 69f924bd00
commit 44211e0bb5
No known key found for this signature in database
GPG Key ID: 67A565EDFDF90E64
10 changed files with 30 additions and 3 deletions

View File

@ -8,6 +8,7 @@ Waf documentation
tutorial.rst tutorial.rst
about.rst about.rst
copyright.rst copyright.rst
confmap.rst
featuremap.rst featuremap.rst
Build.rst Build.rst

View File

@ -19,16 +19,17 @@ def configure(cfg):
cfg.find_program('convert', var='CONVERT') cfg.find_program('convert', var='CONVERT')
cfg.load('daemon', tooldir=['../../playground/daemon/']) cfg.load('daemon', tooldir=['../../playground/daemon/'])
cfg.find_program("sphinx-build", var="SPHINX_BUILD") cfg.find_program("sphinx-build", var="SPHINX_BUILD")
cfg.env.SPHINX_ARGS = ['-W']
def build(bld): def build(bld):
bld.path.make_node('_static').mkdir()
bld( bld(
rule = "${SPHINX_BUILD} -b html -d %s . %s" % (os.path.join(out, "doctrees"), os.path.join(out, "html")), rule = "${SPHINX_BUILD} ${SPHINX_ARGS} -b html -d %s . %s" % (os.path.join(out, "doctrees"), os.path.join(out, "html")),
cwd = bld.path.abspath(), cwd = bld.path.abspath(),
source = bld.path.parent.parent.find_dir('waflib').ant_glob('**/*.py') source = bld.path.parent.parent.find_dir('waflib').ant_glob('**/*.py')
+ bld.path.ant_glob('**/*.rst') + bld.path.ant_glob('**/*.rst')
+ bld.path.ant_glob('_templates/indexcontent.html') + bld.path.ant_glob('_templates/indexcontent.html')
+ bld.path.ant_glob('conf.py'), + bld.path.ant_glob('conf.py'),
target = bld.path.find_or_declare('html/index.html') target = bld.path.find_or_declare('html/index.html')
) )

View File

@ -211,6 +211,9 @@ class grep_for_endianness(Task.Task):
@feature('grep_for_endianness') @feature('grep_for_endianness')
@after_method('process_source') @after_method('process_source')
def grep_for_endianness_fun(self): def grep_for_endianness_fun(self):
"""
Used by the endiannes configuration test
"""
self.create_task('grep_for_endianness', self.compiled_tasks[0].outputs[0]) self.create_task('grep_for_endianness', self.compiled_tasks[0].outputs[0])
@conf @conf

View File

@ -686,6 +686,9 @@ def read_object(self, obj):
@feature('cxxprogram', 'cprogram') @feature('cxxprogram', 'cprogram')
@after_method('apply_link', 'process_use') @after_method('apply_link', 'process_use')
def set_full_paths_hpux(self): def set_full_paths_hpux(self):
"""
On hp-ux, extend the libpaths and static library paths to absolute paths
"""
if self.env.DEST_OS != 'hp-ux': if self.env.DEST_OS != 'hp-ux':
return return
base = self.bld.bldnode.abspath() base = self.bld.bldnode.abspath()

View File

@ -19,6 +19,9 @@ ccroot.USELIB_VARS['fcstlib'] = set(['ARFLAGS', 'LINKDEPS'])
@feature('fcprogram', 'fcshlib', 'fcstlib', 'fcprogram_test') @feature('fcprogram', 'fcshlib', 'fcstlib', 'fcprogram_test')
def dummy(self): def dummy(self):
"""
Unused function that does nothing (TODO: remove in waf 1.9)
"""
pass pass
@extension('.f', '.f90', '.F', '.F90', '.for', '.FOR') @extension('.f', '.f90', '.F', '.F90', '.for', '.FOR')

View File

@ -47,6 +47,9 @@ _style_flags = {
@taskgen_method @taskgen_method
def ensure_localedir(self): def ensure_localedir(self):
"""
Expand LOCALEDIR from DATAROOTDIR/locale if possible, or fallback to PREFIX/share/locale
"""
# use the tool gnu_dirs to provide options to define this # use the tool gnu_dirs to provide options to define this
if not self.env.LOCALEDIR: if not self.env.LOCALEDIR:
if self.env.DATAROOTDIR: if self.env.DATAROOTDIR:

View File

@ -310,6 +310,9 @@ class javac(Task.Task):
@feature('javadoc') @feature('javadoc')
@after_method('process_rule') @after_method('process_rule')
def create_javadoc(self): def create_javadoc(self):
"""
Creates a javadoc task (feature 'javadoc')
"""
tsk = self.create_task('javadoc') tsk = self.create_task('javadoc')
tsk.classpath = getattr(self, 'classpath', []) tsk.classpath = getattr(self, 'classpath', [])
self.javadoc_package = Utils.to_list(self.javadoc_package) self.javadoc_package = Utils.to_list(self.javadoc_package)

View File

@ -1050,6 +1050,9 @@ def make_winapp(self, family):
@after_method('process_use') @after_method('process_use')
@after_method('propagate_uselib_vars') @after_method('propagate_uselib_vars')
def make_winphone_app(self): def make_winphone_app(self):
"""
Insert configuration flags for windows phone applications (adds /ZW, /TP...)
"""
make_winapp(self, 'WINAPI_FAMILY_PHONE_APP') make_winapp(self, 'WINAPI_FAMILY_PHONE_APP')
conf.env.append_unique('LINKFLAGS', '/NODEFAULTLIB:ole32.lib') conf.env.append_unique('LINKFLAGS', '/NODEFAULTLIB:ole32.lib')
conf.env.append_unique('LINKFLAGS', 'PhoneAppModelHost.lib') conf.env.append_unique('LINKFLAGS', 'PhoneAppModelHost.lib')
@ -1059,4 +1062,7 @@ def make_winphone_app(self):
@after_method('process_use') @after_method('process_use')
@after_method('propagate_uselib_vars') @after_method('propagate_uselib_vars')
def make_windows_app(self): def make_windows_app(self):
"""
Insert configuration flags for windows applications (adds /ZW, /TP...)
"""
make_winapp(self, 'WINAPI_FAMILY_DESKTOP_APP') make_winapp(self, 'WINAPI_FAMILY_DESKTOP_APP')

View File

@ -162,6 +162,7 @@ def init_pyext(self):
@feature('pyext') @feature('pyext')
@before_method('apply_link', 'apply_bundle') @before_method('apply_link', 'apply_bundle')
def set_bundle(self): def set_bundle(self):
"""Mac-specific pyext extension that enables bundles from c_osx.py"""
if Utils.unversioned_sys_platform() == 'darwin': if Utils.unversioned_sys_platform() == 'darwin':
self.mac_bundle = True self.mac_bundle = True

View File

@ -43,6 +43,9 @@ valac = Task.update_outputs(valac) # no decorators for python2 classes
@taskgen_method @taskgen_method
def init_vala_task(self): def init_vala_task(self):
"""
Initializes the vala task with the relevant data (acts as a constructor)
"""
self.profile = getattr(self, 'profile', 'gobject') self.profile = getattr(self, 'profile', 'gobject')
if self.profile == 'gobject': if self.profile == 'gobject':