forked from sdr/gr-osmosdr
parent
08b6f7ee0a
commit
c954d4a410
@ -1,3 +0,0 @@ |
||||
/Makefile |
||||
/Makefile.in |
||||
|
@ -1,52 +0,0 @@ |
||||
#
|
||||
# Copyright 2007,2009,2011 Free Software Foundation, Inc.
|
||||
#
|
||||
# This file is part of GNU Radio
|
||||
#
|
||||
# GNU Radio is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation; either version 3, or (at your option)
|
||||
# any later version.
|
||||
#
|
||||
# GNU Radio is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with GNU Radio; see the file COPYING. If not, write to
|
||||
# the Free Software Foundation, Inc., 51 Franklin Street,
|
||||
# Boston, MA 02110-1301, USA.
|
||||
#
|
||||
|
||||
include $(top_srcdir)/Makefile.common |
||||
|
||||
EXTRA_DIST = \
|
||||
example/aadvark.cc \
|
||||
example/aadvark.h \
|
||||
example/Doxyfile \
|
||||
example/xml/aadvark_8cc.xml \
|
||||
example/xml/aadvark_8h.xml \
|
||||
example/xml/classAadvark.xml \
|
||||
example/xml/combine.xslt \
|
||||
example/xml/compound.xsd \
|
||||
example/xml/index.xml \
|
||||
example/xml/index.xsd
|
||||
|
||||
if PYTHON |
||||
utilspythondir = $(grpythondir)/doxyxml
|
||||
|
||||
TESTS = \
|
||||
run_tests
|
||||
|
||||
nobase_utilspython_PYTHON = \
|
||||
__init__.py \
|
||||
base.py \
|
||||
doxyindex.py \
|
||||
text.py \
|
||||
generated/__init__.py \
|
||||
generated/index.py \
|
||||
generated/indexsuper.py \
|
||||
generated/compound.py \
|
||||
generated/compoundsuper.py
|
||||
endif |
@ -1,82 +0,0 @@ |
||||
# |
||||
# Copyright 2010 Free Software Foundation, Inc. |
||||
# |
||||
# This file is part of GNU Radio |
||||
# |
||||
# GNU Radio is free software; you can redistribute it and/or modify |
||||
# it under the terms of the GNU General Public License as published by |
||||
# the Free Software Foundation; either version 3, or (at your option) |
||||
# any later version. |
||||
# |
||||
# GNU Radio is distributed in the hope that it will be useful, |
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
# GNU General Public License for more details. |
||||
# |
||||
# You should have received a copy of the GNU General Public License |
||||
# along with GNU Radio; see the file COPYING. If not, write to |
||||
# the Free Software Foundation, Inc., 51 Franklin Street, |
||||
# Boston, MA 02110-1301, USA. |
||||
# |
||||
""" |
||||
Python interface to contents of doxygen xml documentation. |
||||
|
||||
Example use: |
||||
See the contents of the example folder for the C++ and |
||||
doxygen-generated xml used in this example. |
||||
|
||||
>>> # Parse the doxygen docs. |
||||
>>> import os |
||||
>>> this_dir = os.path.dirname(globals()['__file__']) |
||||
>>> xml_path = this_dir + "/example/xml/" |
||||
>>> di = DoxyIndex(xml_path) |
||||
|
||||
Get a list of all top-level objects. |
||||
|
||||
>>> print([mem.name() for mem in di.members()]) |
||||
[u'Aadvark', u'aadvarky_enough', u'main'] |
||||
|
||||
Get all functions. |
||||
|
||||
>>> print([mem.name() for mem in di.in_category(DoxyFunction)]) |
||||
[u'aadvarky_enough', u'main'] |
||||
|
||||
Check if an object is present. |
||||
|
||||
>>> di.has_member(u'Aadvark') |
||||
True |
||||
>>> di.has_member(u'Fish') |
||||
False |
||||
|
||||
Get an item by name and check its properties. |
||||
|
||||
>>> aad = di.get_member(u'Aadvark') |
||||
>>> print(aad.brief_description) |
||||
Models the mammal Aadvark. |
||||
>>> print(aad.detailed_description) |
||||
Sadly the model is incomplete and cannot capture all aspects of an aadvark yet. |
||||
<BLANKLINE> |
||||
This line is uninformative and is only to test line breaks in the comments. |
||||
>>> [mem.name() for mem in aad.members()] |
||||
[u'aadvarkness', u'print', u'Aadvark', u'get_aadvarkness'] |
||||
>>> aad.get_member(u'print').brief_description |
||||
u'Outputs the vital aadvark statistics.' |
||||
|
||||
""" |
||||
|
||||
from doxyindex import DoxyIndex, DoxyFunction, DoxyParam, DoxyClass, DoxyFile, DoxyNamespace, DoxyGroup, DoxyFriend, DoxyOther |
||||
|
||||
def _test(): |
||||
import os |
||||
this_dir = os.path.dirname(globals()['__file__']) |
||||
xml_path = this_dir + "/example/xml/" |
||||
di = DoxyIndex(xml_path) |
||||
# Get the Aadvark class |
||||
aad = di.get_member('Aadvark') |
||||
aad.brief_description |
||||
import doctest |
||||
return doctest.testmod() |
||||
|
||||
if __name__ == "__main__": |
||||
_test() |
||||
|
@ -1,219 +0,0 @@ |
||||
# |
||||
# Copyright 2010 Free Software Foundation, Inc. |
||||
# |
||||
# This file is part of GNU Radio |
||||
# |
||||
# GNU Radio is free software; you can redistribute it and/or modify |
||||
# it under the terms of the GNU General Public License as published by |
||||
# the Free Software Foundation; either version 3, or (at your option) |
||||
# any later version. |
||||
# |
||||
# GNU Radio is distributed in the hope that it will be useful, |
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
# GNU General Public License for more details. |
||||
# |
||||
# You should have received a copy of the GNU General Public License |
||||
# along with GNU Radio; see the file COPYING. If not, write to |
||||
# the Free Software Foundation, Inc., 51 Franklin Street, |
||||
# Boston, MA 02110-1301, USA. |
||||
# |
||||
""" |
||||
A base class is created. |
||||
|
||||
Classes based upon this are used to make more user-friendly interfaces |
||||
to the doxygen xml docs than the generated classes provide. |
||||
""" |
||||
|
||||
import os |
||||
import pdb |
||||
|
||||
from xml.parsers.expat import ExpatError |
||||
|
||||
from generated import compound |
||||
|
||||
|
||||
class Base(object): |
||||
|
||||
class Duplicate(StandardError): |
||||
pass |
||||
|
||||
class NoSuchMember(StandardError): |
||||
pass |
||||
|
||||
class ParsingError(StandardError): |
||||
pass |
||||
|
||||
def __init__(self, parse_data, top=None): |
||||
self._parsed = False |
||||
self._error = False |
||||
self._parse_data = parse_data |
||||
self._members = [] |
||||
self._dict_members = {} |
||||
self._in_category = {} |
||||
self._data = {} |
||||
if top is not None: |
||||
self._xml_path = top._xml_path |
||||
# Set up holder of references |
||||
else: |
||||
top = self |
||||
self._refs = {} |
||||
self._xml_path = parse_data |
||||
self.top = top |
||||
|
||||
@classmethod |
||||
def from_refid(cls, refid, top=None): |
||||
""" Instantiate class from a refid rather than parsing object. """ |
||||
# First check to see if its already been instantiated. |
||||
if top is not None and refid in top._refs: |
||||
return top._refs[refid] |
||||
# Otherwise create a new instance and set refid. |
||||
inst = cls(None, top=top) |
||||
inst.refid = refid |
||||
inst.add_ref(inst) |
||||
return inst |
||||
|
||||
@classmethod |
||||
def from_parse_data(cls, parse_data, top=None): |
||||
refid = getattr(parse_data, 'refid', None) |
||||
if refid is not None and top is not None and refid in top._refs: |
||||
return top._refs[refid] |
||||
inst = cls(parse_data, top=top) |
||||
if refid is not None: |
||||
inst.refid = refid |
||||
inst.add_ref(inst) |
||||
return inst |
||||
|
||||
def add_ref(self, obj): |
||||
if hasattr(obj, 'refid'): |
||||
self.top._refs[obj.refid] = obj |
||||
|
||||
mem_classes = [] |
||||
|
||||
def get_cls(self, mem): |
||||
for cls in self.mem_classes: |
||||
if cls.can_parse(mem): |
||||
return cls |
||||
raise StandardError(("Did not find a class for object '%s'." \ |
||||
% (mem.get_name()))) |
||||
|
||||
def convert_mem(self, mem): |
||||
try: |
||||
cls = self.get_cls(mem) |
||||
converted = cls.from_parse_data(mem, self.top) |
||||
if converted is None: |
||||
raise StandardError('No class matched this object.') |
||||
self.add_ref(converted) |
||||
return converted |
||||
except StandardError, e: |
||||
print e |
||||
|
||||
@classmethod |
||||
def includes(cls, inst): |
||||
return isinstance(inst, cls) |
||||
|
||||
@classmethod |
||||
def can_parse(cls, obj): |
||||
return False |
||||
|
||||
def _parse(self): |
||||
self._parsed = True |
||||
|
||||
def _get_dict_members(self, cat=None): |
||||
""" |
||||
For given category a dictionary is returned mapping member names to |
||||
members of that category. For names that are duplicated the name is |
||||
mapped to None. |
||||
""" |
||||
self.confirm_no_error() |
||||
if cat not in self._dict_members: |
||||
new_dict = {} |
||||
for mem in self.in_category(cat): |
||||
if mem.name() not in new_dict: |
||||
new_dict[mem.name()] = mem |
||||
else: |
||||
new_dict[mem.name()] = self.Duplicate |
||||
self._dict_members[cat] = new_dict |
||||
return self._dict_members[cat] |
||||
|
||||
def in_category(self, cat): |
||||
self.confirm_no_error() |
||||
if cat is None: |
||||
return self._members |
||||
if cat not in self._in_category: |
||||
self._in_category[cat] = [mem for mem in self._members |
||||
if cat.includes(mem)] |
||||
return self._in_category[cat] |
||||
|
||||
def get_member(self, name, cat=None): |
||||
self.confirm_no_error() |
||||
# Check if it's in a namespace or class. |
||||
bits = name.split('::') |
||||
first = bits[0] |
||||
rest = '::'.join(bits[1:]) |
||||
member = self._get_dict_members(cat).get(first, self.NoSuchMember) |
||||
# Raise any errors that are returned. |
||||
if member in set([self.NoSuchMember, self.Duplicate]): |
||||
raise member() |
||||
if rest: |
||||
return member.get_member(rest, cat=cat) |
||||
return member |
||||
|
||||
def has_member(self, name, cat=None): |
||||
try: |
||||
mem = self.get_member(name, cat=cat) |
||||
return True |
||||
except self.NoSuchMember: |
||||
return False |
||||
|
||||
def data(self): |
||||
self.confirm_no_error() |
||||
return self._data |
||||
|
||||
def members(self): |
||||
self.confirm_no_error() |
||||
return self._members |
||||
|
||||
def process_memberdefs(self): |
||||
mdtss = [] |
||||
for sec in self._retrieved_data.compounddef.sectiondef: |
||||
mdtss += sec.memberdef |
||||
# At the moment we lose all information associated with sections. |
||||
# Sometimes a memberdef is in several sectiondef. |
||||
# We make sure we don't get duplicates here. |
||||
uniques = set([]) |
||||
for mem in mdtss: |
||||
converted = self.convert_mem(mem) |
||||
pair = (mem.name, mem.__class__) |
||||
if pair not in uniques: |
||||
uniques.add(pair) |
||||
self._members.append(converted) |
||||
|
||||
def retrieve_data(self): |
||||
filename = os.path.join(self._xml_path, self.refid + '.xml') |
||||
try: |
||||
self._retrieved_data = compound.parse(filename) |
||||
except ExpatError: |
||||
print('Error in xml in file %s' % filename) |
||||
self._error = True |
||||
self._retrieved_data = None |
||||
|
||||
def check_parsed(self): |
||||
if not self._parsed: |
||||
self._parse() |
||||
|
||||
def confirm_no_error(self): |
||||
self.check_parsed() |
||||
if self._error: |
||||
raise self.ParsingError() |
||||
|
||||
def error(self): |
||||
self.check_parsed() |
||||
return self._error |
||||
|
||||
def name(self): |
||||
# first see if we can do it without processing. |
||||
if self._parse_data is not None: |
||||
return self._parse_data.name |
||||
self.check_parsed() |
||||
return self._retrieved_data.compounddef.name |
@ -1,237 +0,0 @@ |
||||
# |
||||
# Copyright 2010 Free Software Foundation, Inc. |
||||
# |
||||
# This file is part of GNU Radio |
||||
# |
||||
# GNU Radio is free software; you can redistribute it and/or modify |
||||
# it under the terms of the GNU General Public License as published by |
||||
# the Free Software Foundation; either version 3, or (at your option) |
||||
# any later version. |
||||
# |
||||
# GNU Radio is distributed in the hope that it will be useful, |
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
# GNU General Public License for more details. |
||||
# |
||||
# You should have received a copy of the GNU General Public License |
||||
# along with GNU Radio; see the file COPYING. If not, write to |
||||
# the Free Software Foundation, Inc., 51 Franklin Street, |
||||
# Boston, MA 02110-1301, USA. |
||||
# |
||||
""" |
||||
Classes providing more user-friendly interfaces to the doxygen xml |
||||
docs than the generated classes provide. |
||||
""" |
||||
|
||||
import os |
||||
|
||||
from generated import index |
||||
from base import Base |
||||
from text import description |
||||
|
||||
class DoxyIndex(Base): |
||||
""" |
||||
Parses a doxygen xml directory. |
||||
""" |
||||
|
||||
__module__ = "gnuradio.utils.doxyxml" |
||||
|
||||
def _parse(self): |
||||
if self._parsed: |
||||
return |
||||
super(DoxyIndex, self)._parse() |
||||
self._root = index.parse(os.path.join(self._xml_path, 'index.xml')) |
||||
for mem in self._root.compound: |
||||
converted = self.convert_mem(mem) |
||||
# For files we want the contents to be accessible directly |
||||
# from the parent rather than having to go through the file |
||||
# object. |
||||
if self.get_cls(mem) == DoxyFile: |
||||
if mem.name.endswith('.h'): |
||||
self._members += converted.members() |
||||
self._members.append(converted) |
||||
else: |
||||
self._members.append(converted) |
||||
|
||||
|
||||
def generate_swig_doc_i(self): |
||||
""" |
||||
%feature("docstring") gr_make_align_on_samplenumbers_ss::align_state " |
||||
Wraps the C++: gr_align_on_samplenumbers_ss::align_state"; |
||||
""" |
||||
pass |
||||
|
||||
|
||||
class DoxyCompMem(Base): |
||||
|
||||
|
||||
kind = None |
||||
|
||||
def __init__(self, *args, **kwargs): |
||||
super(DoxyCompMem, self).__init__(*args, **kwargs) |
||||
|
||||
@classmethod |
||||
def can_parse(cls, obj): |
||||
return obj.kind == cls.kind |
||||
|
||||
def set_descriptions(self, parse_data): |
||||
bd = description(getattr(parse_data, 'briefdescription', None)) |
||||
dd = description(getattr(parse_data, 'detaileddescription', None)) |
||||
self._data['brief_description'] = bd |
||||
self._data['detailed_description'] = dd |
||||
|
||||
class DoxyCompound(DoxyCompMem): |
||||
pass |
||||
|
||||
class DoxyMember(DoxyCompMem): |
||||
pass |
||||
|
||||
|
||||
class DoxyFunction(DoxyMember): |
||||
|
||||
__module__ = "gnuradio.utils.doxyxml" |
||||
|
||||
kind = 'function' |
||||
|
||||
def _parse(self): |
||||
if self._parsed: |
||||
return |
||||
super(DoxyFunction, self)._parse() |
||||
self.set_descriptions(self._parse_data) |
||||
self._data['params'] = [] |
||||
prms = self._parse_data.param |
||||
for prm in prms: |
||||
self._data['params'].append(DoxyParam(prm)) |
||||
|
||||
brief_description = property(lambda self: self.data()['brief_description']) |
||||
detailed_description = property(lambda self: self.data()['detailed_description']) |
||||
params = property(lambda self: self.data()['params']) |
||||
|
||||
Base.mem_classes.append(DoxyFunction) |
||||
|
||||
|
||||
class DoxyParam(DoxyMember): |
||||
|
||||
__module__ = "gnuradio.utils.doxyxml" |
||||
|
||||
def _parse(self): |
||||
if self._parsed: |
||||
return |
||||
super(DoxyParam, self)._parse() |
||||
self.set_descriptions(self._parse_data) |
||||
self._data['declname'] = self._parse_data.declname |
||||
|
||||
brief_description = property(lambda self: self.data()['brief_description']) |
||||
detailed_description = property(lambda self: self.data()['detailed_description']) |
||||
declname = property(lambda self: self.data()['declname']) |
||||
|
||||
class DoxyClass(DoxyCompound): |
||||
|
||||
__module__ = "gnuradio.utils.doxyxml" |
||||
|
||||
kind = 'class' |
||||
|
||||
def _parse(self): |
||||
if self._parsed: |
||||
return |
||||
super(DoxyClass, self)._parse() |
||||
self.retrieve_data() |
||||
if self._error: |
||||
return |
||||
self.set_descriptions(self._retrieved_data.compounddef) |
||||
# Sectiondef.kind tells about whether private or public. |
||||
# We just ignore this for now. |
||||
self.process_memberdefs() |
||||
|
||||
brief_description = property(lambda self: self.data()['brief_description']) |
||||
detailed_description = property(lambda self: self.data()['detailed_description']) |
||||
|
||||
Base.mem_classes.append(DoxyClass) |
||||
|
||||
|
||||
class DoxyFile(DoxyCompound): |
||||
|
||||
__module__ = "gnuradio.utils.doxyxml" |
||||
|
||||
kind = 'file' |
||||
|
||||
def _parse(self): |
||||
if self._parsed: |
||||
return |
||||
super(DoxyFile, self)._parse() |
||||
self.retrieve_data() |
||||
self.set_descriptions(self._retrieved_data.compounddef) |
||||
if self._error: |
||||
return |
||||
self.process_memberdefs() |
||||
|
||||
brief_description = property(lambda self: self.data()['brief_description']) |
||||
detailed_description = property(lambda self: self.data()['detailed_description']) |
||||
|
||||
Base.mem_classes.append(DoxyFile) |
||||
|
||||
|
||||
class DoxyNamespace(DoxyCompound): |
||||
|
||||
__module__ = "gnuradio.utils.doxyxml" |
||||
|
||||
kind = 'namespace' |
||||
|
||||
Base.mem_classes.append(DoxyNamespace) |
||||
|
||||
|
||||
class DoxyGroup(DoxyCompound): |
||||
|
||||
__module__ = "gnuradio.utils.doxyxml" |
||||
|
||||
kind = 'group' |
||||
|
||||
def _parse(self): |
||||
if self._parsed: |
||||
return |
||||
super(DoxyGroup, self)._parse() |
||||
self.retrieve_data() |
||||
if self._error: |
||||
return |
||||
cdef = self._retrieved_data.compounddef |
||||
self._data['title'] = description(cdef.title) |
||||
# Process inner groups |
||||
grps = cdef.innergroup |
||||
for grp in grps: |
||||
converted = DoxyGroup.from_refid(grp.refid, top=self.top) |
||||
self._members.append(converted) |
||||
# Process inner classes |
||||
klasses = cdef.innerclass |
||||
for kls in klasses: |
||||
converted = DoxyClass.from_refid(kls.refid, top=self.top) |
||||
self._members.append(converted) |
||||
# Process normal members |
||||
self.process_memberdefs() |
||||
|
||||
title = property(lambda self: self.data()['title']) |
||||
|
||||
|
||||
Base.mem_classes.append(DoxyGroup) |
||||
|
||||
|
||||
class DoxyFriend(DoxyMember): |
||||
|
||||
__module__ = "gnuradio.utils.doxyxml" |
||||
|
||||
kind = 'friend' |
||||
|
||||
Base.mem_classes.append(DoxyFriend) |
||||
|
||||
|
||||
class DoxyOther(Base): |
||||
|
||||
__module__ = "gnuradio.utils.doxyxml" |
||||
|
||||
kinds = set(['variable', 'struct', 'union', 'define', 'typedef', 'enum', 'dir', 'page']) |
||||
|
||||
@classmethod |
||||
def can_parse(cls, obj): |
||||
return obj.kind in cls.kinds |
||||
|
||||
Base.mem_classes.append(DoxyOther) |
||||
|
File diff suppressed because it is too large
Load Diff
@ -1,50 +0,0 @@ |
||||
/* -*- c++ -*- */ |
||||
/*
|
||||
* Copyright 2010 Free Software Foundation, Inc. |
||||
*
|
||||
* This file is part of GNU Radio |
||||
*
|
||||
* GNU Radio is free software; you can redistribute it and/or modify |
||||
* it under the terms of the GNU General Public License as published by |
||||
* the Free Software Foundation; either version 3, or (at your option) |
||||
* any later version. |
||||
*
|
||||
* GNU Radio is distributed in the hope that it will be useful, |
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
* GNU General Public License for more details. |
||||
*
|
||||
* You should have received a copy of the GNU General Public License |
||||
* along with GNU Radio; see the file COPYING. If not, write to |
||||
* the Free Software Foundation, Inc., 51 Franklin Street, |
||||
* Boston, MA 02110-1301, USA. |
||||
*/ |
||||
#include <iostream> |
||||
#include "aadvark.h" |
||||
|
||||
void Aadvark::print() { |
||||
std::cout << "aadvark is " << aadvarkness << "/10 aadvarky" << std::endl; |
||||
} |
||||
|
||||
Aadvark::Aadvark(int aaness): aadvarkness(aaness) {} |
||||
|
||||
bool aadvarky_enough(Aadvark aad) { |
||||
if (aad.get_aadvarkness() > 6) |
||||
return true; |
||||
else |
||||
return false; |
||||
} |
||||
|
||||
int Aadvark::get_aadvarkness() { |
||||
return aadvarkness; |
||||
} |
||||
|
||||
int main() { |
||||
Aadvark arold = Aadvark(6); |
||||
arold.print(); |
||||
if (aadvarky_enough(arold)) |
||||
std::cout << "He is aadvarky enough" << std::endl; |
||||
else |
||||
std::cout << "He is not aadvarky enough" << std::endl; |
||||
} |
||||
|
@ -1,44 +0,0 @@ |
||||
/* -*- c++ -*- */ |
||||
/*
|
||||
* Copyright 2010 Free Software Foundation, Inc. |
||||
*
|
||||
* This file is part of GNU Radio |
||||
*
|
||||
* GNU Radio is free software; you can redistribute it and/or modify |
||||
* it under the terms of the GNU General Public License as published by |
||||
* the Free Software Foundation; either version 3, or (at your option) |
||||
* any later version. |
||||
*
|
||||
* GNU Radio is distributed in the hope that it will be useful, |
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
* GNU General Public License for more details. |
||||
*
|
||||
* You should have received a copy of the GNU General Public License |
||||
* along with GNU Radio; see the file COPYING. If not, write to |
||||
* the Free Software Foundation, Inc., 51 Franklin Street, |
||||
* Boston, MA 02110-1301, USA. |
||||
*/ |
||||
#include <iostream> |
||||
|
||||
/*!
|
||||
* \brief Models the mammal Aadvark. |
||||
* |
||||
* Sadly the model is incomplete and cannot capture all aspects of an aadvark yet. |
||||
* |
||||
* This line is uninformative and is only to test line breaks in the comments. |
||||
*/ |
||||
class Aadvark { |
||||
public: |
||||
//! \brief Outputs the vital aadvark statistics.
|
||||
void print(); |
||||
//! \param aaness The aadvarkness of an aadvark is a measure of how aadvarky it is.
|
||||
Aadvark(int aaness); |
||||
int get_aadvarkness(); |
||||
private: |
||||
int aadvarkness; |
||||
}; |
||||
|
||||
bool aadvarky_enough(Aadvark aad); |
||||
|
||||
int main(); |
@ -1,88 +0,0 @@ |
||||
<?xml version='1.0' encoding='UTF-8' standalone='no'?> |
||||
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.6.3"> |
||||
<compounddef id="aadvark_8cc" kind="file"> |
||||
<compoundname>aadvark.cc</compoundname> |
||||
<includes local="no">iostream</includes> |
||||
<includes refid="aadvark_8cc" local="yes">aadvark.h</includes> |
||||
<includedby refid="aadvark_8cc" local="yes">aadvark.cc</includedby> |
||||
<incdepgraph> |
||||
<node id="0"> |
||||
<label>aadvark.cc</label> |
||||
<link refid="aadvark.cc"/> |
||||
<childnode refid="1" relation="include"> |
||||
</childnode> |
||||
</node> |
||||
<node id="1"> |
||||
<label>iostream</label> |
||||
</node> |
||||
</incdepgraph> |
||||
<sectiondef kind="func"> |
||||
<memberdef kind="function" id="aadvark_8cc_1acb52858524210ec6dddc3e16d1e52946" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
||||
<type>bool</type> |
||||
<definition>bool aadvarky_enough</definition> |
||||
<argsstring>(Aadvark aad)</argsstring> |
||||
<name>aadvarky_enough</name> |
||||
<param> |
||||
<type><ref refid="classAadvark" kindref="compound">Aadvark</ref></type> |
||||
<declname>aad</declname> |
||||
</param> |
||||
<briefdescription> |
||||
</briefdescription> |
||||
<detaileddescription> |
||||
</detaileddescription> |
||||
<inbodydescription> |
||||
</inbodydescription> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" line="10" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="10" bodyend="15"/> |
||||
</memberdef> |
||||
<memberdef kind="function" id="aadvark_8cc_1ae66f6b31b5ad750f1fe042a706a4e3d4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
||||
<type>int</type> |
||||
<definition>int main</definition> |
||||
<argsstring>()</argsstring> |
||||
<name>main</name> |
||||
<briefdescription> |
||||
</briefdescription> |
||||
<detaileddescription> |
||||
</detaileddescription> |
||||
<inbodydescription> |
||||
</inbodydescription> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" line="21" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="21" bodyend="28"/> |
||||
</memberdef> |
||||
</sectiondef> |
||||
<briefdescription> |
||||
</briefdescription> |
||||
<detaileddescription> |
||||
</detaileddescription> |
||||
<programlisting> |
||||
<codeline lineno="1"><highlight class="preprocessor">#include<sp/><iostream></highlight><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="2"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"aadvark.h"</highlight><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="3"><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="classAadvark_1abd061aa5f998002e72080a34f512a059" kindref="member" tooltip="Outputs the vital aadvark statistics.">Aadvark::print</ref>()<sp/>{</highlight></codeline> |
||||
<codeline lineno="5"><highlight class="normal"><sp/><sp/>std::cout<sp/><<<sp/></highlight><highlight class="stringliteral">"aadvark<sp/>is<sp/>"</highlight><highlight class="normal"><sp/><<<sp/>aadvarkness<sp/><<<sp/></highlight><highlight class="stringliteral">"/10<sp/>aadvarky"</highlight><highlight class="normal"><sp/><<<sp/>std::endl;</highlight></codeline> |
||||
<codeline lineno="6"><highlight class="normal">}</highlight></codeline> |
||||
<codeline lineno="7"><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="8"><highlight class="normal"><ref refid="classAadvark_1adf1a4b97a641411a74a04ab312484462" kindref="member">Aadvark::Aadvark</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>aaness):<sp/>aadvarkness(aaness)<sp/>{}</highlight></codeline> |
||||
<codeline lineno="9"><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="10"><highlight class="normal"></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>aadvarky_enough(<ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref><sp/>aad)<sp/>{</highlight></codeline> |
||||
<codeline lineno="11"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(aad.get_aadvarkness()<sp/>><sp/>6)</highlight></codeline> |
||||
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">true</highlight><highlight class="normal">;</highlight></codeline> |
||||
<codeline lineno="13"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">else</highlight><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">false</highlight><highlight class="normal">;</highlight></codeline> |
||||
<codeline lineno="15"><highlight class="normal">}</highlight></codeline> |
||||
<codeline lineno="16"><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="17"><highlight class="normal"></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>Aadvark::get_aadvarkness()<sp/>{</highlight></codeline> |
||||
<codeline lineno="18"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>aadvarkness;</highlight></codeline> |
||||
<codeline lineno="19"><highlight class="normal">}</highlight></codeline> |
||||
<codeline lineno="20"><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="21"><highlight class="normal"></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>main()<sp/>{</highlight></codeline> |
||||
<codeline lineno="22"><highlight class="normal"><sp/><sp/><ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref><sp/>arold<sp/>=<sp/><ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref>(6);</highlight></codeline> |
||||
<codeline lineno="23"><highlight class="normal"><sp/><sp/>arold.<ref refid="classAadvark_1abd061aa5f998002e72080a34f512a059" kindref="member" tooltip="Outputs the vital aadvark statistics.">print</ref>();</highlight></codeline> |
||||
<codeline lineno="24"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(aadvarky_enough(arold))</highlight></codeline> |
||||
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/>std::cout<sp/><<<sp/></highlight><highlight class="stringliteral">"He<sp/>is<sp/>aadvarky<sp/>enough"</highlight><highlight class="normal"><sp/><<<sp/>std::endl;</highlight></codeline> |
||||
<codeline lineno="26"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">else</highlight><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/>std::cout<sp/><<<sp/></highlight><highlight class="stringliteral">"He<sp/>is<sp/>not<sp/>aadvarky<sp/>enough"</highlight><highlight class="normal"><sp/><<<sp/>std::endl;</highlight></codeline> |
||||
<codeline lineno="28"><highlight class="normal">}</highlight></codeline> |
||||
<codeline lineno="29"><highlight class="normal"></highlight></codeline> |
||||
</programlisting> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc"/> |
||||
</compounddef> |
||||
</doxygen> |
@ -1,72 +0,0 @@ |
||||
<?xml version='1.0' encoding='UTF-8' standalone='no'?> |
||||
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.6.3"> |
||||
<compounddef id="aadvark_8h" kind="file"> |
||||
<compoundname>aadvark.h</compoundname> |
||||
<includes local="no">iostream</includes> |
||||
<incdepgraph> |
||||
<node id="3"> |
||||
<label>aadvark.h</label> |
||||
<link refid="aadvark.h"/> |
||||
<childnode refid="4" relation="include"> |
||||
</childnode> |
||||
</node> |
||||
<node id="4"> |
||||
<label>iostream</label> |
||||
</node> |
||||
</incdepgraph> |
||||
<innerclass refid="classAadvark" prot="public">Aadvark</innerclass> |
||||
<sectiondef kind="func"> |
||||
<memberdef kind="function" id="aadvark_8h_1acb52858524210ec6dddc3e16d1e52946" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
||||
<type>bool</type> |
||||
<definition>bool aadvarky_enough</definition> |
||||
<argsstring>(Aadvark aad)</argsstring> |
||||
<name>aadvarky_enough</name> |
||||
<param> |
||||
<type><ref refid="classAadvark" kindref="compound">Aadvark</ref></type> |
||||
<declname>aad</declname> |
||||
</param> |
||||
<briefdescription> |
||||
</briefdescription> |
||||
<detaileddescription> |
||||
</detaileddescription> |
||||
<inbodydescription> |
||||
</inbodydescription> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="21" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="10" bodyend="15"/> |
||||
</memberdef> |
||||
<memberdef kind="function" id="aadvark_8h_1ae66f6b31b5ad750f1fe042a706a4e3d4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
||||
<type>int</type> |
||||
<definition>int main</definition> |
||||
<argsstring>()</argsstring> |
||||
<name>main</name> |
||||
<briefdescription> |
||||
</briefdescription> |
||||
<detaileddescription> |
||||
</detaileddescription> |
||||
<inbodydescription> |
||||
</inbodydescription> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="23" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="21" bodyend="28"/> |
||||
</memberdef> |
||||
</sectiondef> |
||||
<briefdescription> |
||||
</briefdescription> |
||||
<detaileddescription> |
||||
</detaileddescription> |
||||
<programlisting> |
||||
<codeline lineno="1"><highlight class="preprocessor">#include<sp/><iostream></highlight><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="2"><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="10" refid="classAadvark" refkind="compound"><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref><sp/>{</highlight></codeline> |
||||
<codeline lineno="11"><highlight class="normal"></highlight><highlight class="keyword">public</highlight><highlight class="normal">:</highlight></codeline> |
||||
<codeline lineno="13"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="classAadvark_1abd061aa5f998002e72080a34f512a059" kindref="member" tooltip="Outputs the vital aadvark statistics.">print</ref>();</highlight></codeline> |
||||
<codeline lineno="15"><highlight class="normal"><sp/><sp/><ref refid="classAadvark_1adf1a4b97a641411a74a04ab312484462" kindref="member">Aadvark</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>aaness);</highlight></codeline> |
||||
<codeline lineno="16"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>get_aadvarkness();</highlight></codeline> |
||||
<codeline lineno="17"><highlight class="normal"></highlight><highlight class="keyword">private</highlight><highlight class="normal">:</highlight></codeline> |
||||
<codeline lineno="18"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>aadvarkness;</highlight></codeline> |
||||
<codeline lineno="19"><highlight class="normal">};</highlight></codeline> |
||||
<codeline lineno="20"><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="21"><highlight class="normal"></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>aadvarky_enough(<ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref><sp/>aad);</highlight></codeline> |
||||
<codeline lineno="22"><highlight class="normal"></highlight></codeline> |
||||
<codeline lineno="23"><highlight class="normal"></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>main();</highlight></codeline> |
||||
</programlisting> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h"/> |
||||
</compounddef> |
||||
</doxygen> |
@ -1,86 +0,0 @@ |
||||
<?xml version='1.0' encoding='UTF-8' standalone='no'?> |
||||
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.6.3"> |
||||
<compounddef id="classAadvark" kind="class" prot="public"> |
||||
<compoundname>Aadvark</compoundname> |
||||
<includes refid="aadvark_8h" local="no">aadvark.h</includes> |
||||
<sectiondef kind="private-attrib"> |
||||
<memberdef kind="variable" id="classAadvark_1ab79eb58d7bb9d5ddfa5d6f783836cab9" prot="private" static="no" mutable="no"> |
||||
<type>int</type> |
||||
<definition>int Aadvark::aadvarkness</definition> |
||||
<argsstring></argsstring> |
||||
<name>aadvarkness</name> |
||||
<briefdescription> |
||||
</briefdescription> |
||||
<detaileddescription> |
||||
</detaileddescription> |
||||
<inbodydescription> |
||||
</inbodydescription> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="18" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" bodystart="18" bodyend="-1"/> |
||||
</memberdef> |
||||
</sectiondef> |
||||
<sectiondef kind="public-func"> |
||||
<memberdef kind="function" id="classAadvark_1abd061aa5f998002e72080a34f512a059" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
||||
<type>void</type> |
||||
<definition>void Aadvark::print</definition> |
||||
<argsstring>()</argsstring> |
||||
<name>print</name> |
||||
<briefdescription> |
||||
<para>Outputs the vital aadvark statistics. </para> </briefdescription> |
||||
<detaileddescription> |
||||
</detaileddescription> |
||||
<inbodydescription> |
||||
</inbodydescription> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="13" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="4" bodyend="6"/> |
||||
</memberdef> |
||||
<memberdef kind="function" id="classAadvark_1adf1a4b97a641411a74a04ab312484462" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
||||
<type></type> |
||||
<definition>Aadvark::Aadvark</definition> |
||||
<argsstring>(int aaness)</argsstring> |
||||
<name>Aadvark</name> |
||||
<param> |
||||
<type>int</type> |
||||
<declname>aaness</declname> |
||||
</param> |
||||
<briefdescription> |
||||
</briefdescription> |
||||
<detaileddescription> |
||||
<para><parameterlist kind="param"><parameteritem> |
||||
<parameternamelist> |
||||
<parametername>aaness</parametername> |
||||
</parameternamelist> |
||||
<parameterdescription> |
||||
<para>The aadvarkness of an aadvark is a measure of how aadvarky it is. </para></parameterdescription> |
||||
</parameteritem> |
||||
</parameterlist> |
||||
</para> </detaileddescription> |
||||
<inbodydescription> |
||||
</inbodydescription> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="15" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="8" bodyend="8"/> |
||||
</memberdef> |
||||
<memberdef kind="function" id="classAadvark_1affd2ada0a85807efcbe26615a848f53e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
||||
<type>int</type> |
||||
<definition>int Aadvark::get_aadvarkness</definition> |
||||
<argsstring>()</argsstring> |
||||
<name>get_aadvarkness</name> |
||||
<briefdescription> |
||||
</briefdescription> |
||||
<detaileddescription> |
||||
</detaileddescription> |
||||
<inbodydescription> |
||||
</inbodydescription> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="16" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="17" bodyend="19"/> |
||||
</memberdef> |
||||
</sectiondef> |
||||
<briefdescription> |
||||
<para>Models the mammal <ref refid="classAadvark" kindref="compound">Aadvark</ref>. </para> </briefdescription> |
||||
<detaileddescription> |
||||
<para>Sadly the model is incomplete and cannot capture all aspects of an aadvark yet.</para><para>This line is uninformative and is only to test line breaks in the comments. </para> </detaileddescription> |
||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="10" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" bodystart="10" bodyend="19"/> |
||||
<listofallmembers> |
||||
<member refid="classAadvark_1adf1a4b97a641411a74a04ab312484462" prot="public" virt="non-virtual"><scope>Aadvark</scope><name>Aadvark</name></member> |
||||
<member refid="classAadvark_1ab79eb58d7bb9d5ddfa5d6f783836cab9" prot="private" virt="non-virtual"><scope>Aadvark</scope><name>aadvarkness</name></member> |
||||
<member refid="classAadvark_1affd2ada0a85807efcbe26615a848f53e" prot="public" virt="non-virtual"><scope>Aadvark</scope><name>get_aadvarkness</name></member> |
||||
<member refid="classAadvark_1abd061aa5f998002e72080a34f512a059" prot="public" virt="non-virtual"><scope>Aadvark</scope><name>print</name></member> |
||||
</listofallmembers> |
||||
</compounddef> |
||||
</doxygen> |
@ -1,15 +0,0 @@ |
||||
<!-- XSLT script to combine the generated output into a single file. |
||||
If you have xsltproc you could use: |
||||
xsltproc combine.xslt index.xml >all.xml |
||||
--> |
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> |
||||
<xsl:output method="xml" version="1.0" indent="yes" standalone="yes" /> |
||||
<xsl:template match="/"> |
||||
<doxygen version="{doxygenindex/@version}"> |
||||
<!-- Load all doxgen generated xml files --> |
||||
<xsl:for-each select="doxygenindex/compound"> |
||||
<xsl:copy-of select="document( concat( @refid, '.xml' ) )/doxygen/*" /> |
||||
</xsl:for-each> |
||||
</doxygen> |
||||
</xsl:template> |
||||
</xsl:stylesheet> |
@ -1,814 +0,0 @@ |
||||
<?xml version='1.0' encoding='utf-8' ?> |
||||
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"> |
||||
<xsd:element name="doxygen" type="DoxygenType"/> |
||||
|
||||
<!-- Complex types --> |
||||
|
||||
<xsd:complexType name="DoxygenType"> |
||||
<xsd:sequence maxOccurs="unbounded"> |
||||
<xsd:element name="compounddef" type="compounddefType" minOccurs="0" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="version" type="DoxVersionNumber" use="required" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="compounddefType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="compoundname" type="xsd:string"/> |
||||
<xsd:element name="title" type="xsd:string" minOccurs="0" /> |
||||
<xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="incdepgraph" type="graphType" minOccurs="0" /> |
||||
<xsd:element name="invincdepgraph" type="graphType" minOccurs="0" /> |
||||
<xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" /> |
||||
<xsd:element name="sectiondef" type="sectiondefType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="briefdescription" type="descriptionType" minOccurs="0" /> |
||||
<xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" /> |
||||
<xsd:element name="inheritancegraph" type="graphType" minOccurs="0" /> |
||||
<xsd:element name="collaborationgraph" type="graphType" minOccurs="0" /> |
||||
<xsd:element name="programlisting" type="listingType" minOccurs="0" /> |
||||
<xsd:element name="location" type="locationType" minOccurs="0" /> |
||||
<xsd:element name="listofallmembers" type="listofallmembersType" minOccurs="0" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="id" type="xsd:string" /> |
||||
<xsd:attribute name="kind" type="DoxCompoundKind" /> |
||||
<xsd:attribute name="prot" type="DoxProtectionKind" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="listofallmembersType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="memberRefType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="scope" /> |
||||
<xsd:element name="name" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="refid" type="xsd:string" /> |
||||
<xsd:attribute name="prot" type="DoxProtectionKind" /> |
||||
<xsd:attribute name="virt" type="DoxVirtualKind" /> |
||||
<xsd:attribute name="ambiguityscope" type="xsd:string" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="compoundRefType" mixed="true"> |
||||
<xsd:simpleContent> |
||||
<xsd:extension base="xsd:string"> |
||||
<xsd:attribute name="refid" type="xsd:string" use="optional" /> |
||||
<xsd:attribute name="prot" type="DoxProtectionKind" /> |
||||
<xsd:attribute name="virt" type="DoxVirtualKind" /> |
||||
</xsd:extension> |
||||
</xsd:simpleContent> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="reimplementType" mixed="true"> |
||||
<xsd:simpleContent> |
||||
<xsd:extension base="xsd:string"> |
||||
<xsd:attribute name="refid" type="xsd:string" /> |
||||
</xsd:extension> |
||||
</xsd:simpleContent> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="incType" mixed="true"> |
||||
<xsd:simpleContent> |
||||
<xsd:extension base="xsd:string"> |
||||
<xsd:attribute name="refid" type="xsd:string" /> |
||||
<xsd:attribute name="local" type="DoxBool" /> |
||||
</xsd:extension> |
||||
</xsd:simpleContent> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="refType" mixed="true"> |
||||
<xsd:simpleContent> |
||||
<xsd:extension base="xsd:string"> |
||||
<xsd:attribute name="refid" type="xsd:string" /> |
||||
<xsd:attribute name="prot" type="DoxProtectionKind" use="optional"/> |
||||
</xsd:extension> |
||||
</xsd:simpleContent> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="refTextType" mixed="true"> |
||||
<xsd:simpleContent> |
||||
<xsd:extension base="xsd:string"> |
||||
<xsd:attribute name="refid" type="xsd:string" /> |
||||
<xsd:attribute name="kindref" type="DoxRefKind" /> |
||||
<xsd:attribute name="external" type="xsd:string" use="optional"/> |
||||
<xsd:attribute name="tooltip" type="xsd:string" use="optional"/> |
||||
</xsd:extension> |
||||
</xsd:simpleContent> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="sectiondefType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="header" type="xsd:string" minOccurs="0" /> |
||||
<xsd:element name="description" type="descriptionType" minOccurs="0" /> |
||||
<xsd:element name="memberdef" type="memberdefType" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="kind" type="DoxSectionKind" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="memberdefType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" /> |
||||
<xsd:element name="type" type="linkedTextType" minOccurs="0" /> |
||||
<xsd:element name="definition" minOccurs="0" /> |
||||
<xsd:element name="argsstring" minOccurs="0" /> |
||||
<xsd:element name="name" /> |
||||
<xsd:element name="read" minOccurs="0" /> |
||||
<xsd:element name="write" minOccurs="0" /> |
||||
<xsd:element name="bitfield" minOccurs="0" /> |
||||
<xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="initializer" type="linkedTextType" minOccurs="0" /> |
||||
<xsd:element name="exceptions" type="linkedTextType" minOccurs="0" /> |
||||
<xsd:element name="briefdescription" type="descriptionType" minOccurs="0" /> |
||||
<xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" /> |
||||
<xsd:element name="inbodydescription" type="descriptionType" minOccurs="0" /> |
||||
<xsd:element name="location" type="locationType" /> |
||||
<xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="kind" type="DoxMemberKind" /> |
||||
<xsd:attribute name="id" type="xsd:string" /> |
||||
<xsd:attribute name="prot" type="DoxProtectionKind" /> |
||||
<xsd:attribute name="static" type="DoxBool" /> |
||||
<xsd:attribute name="const" type="DoxBool" /> |
||||
<xsd:attribute name="explicit" type="DoxBool" /> |
||||
<xsd:attribute name="inline" type="DoxBool" /> |
||||
<xsd:attribute name="virt" type="DoxVirtualKind" /> |
||||
<xsd:attribute name="volatile" type="DoxBool" /> |
||||
<xsd:attribute name="mutable" type="DoxBool" /> |
||||
<!-- Qt property --> |
||||
<xsd:attribute name="readable" type="DoxBool" use="optional"/> |
||||
<xsd:attribute name="writable" type="DoxBool" use="optional"/> |
||||
<!-- C++/CLI variable --> |
||||
<xsd:attribute name="initonly" type="DoxBool" use="optional"/> |
||||
<!-- C++/CLI and C# property --> |
||||
<xsd:attribute name="settable" type="DoxBool" use="optional"/> |
||||
<xsd:attribute name="gettable" type="DoxBool" use="optional"/> |
||||
<!-- C++/CLI function --> |
||||
<xsd:attribute name="final" type="DoxBool" use="optional"/> |
||||
<xsd:attribute name="sealed" type="DoxBool" use="optional"/> |
||||
<xsd:attribute name="new" type="DoxBool" use="optional"/> |
||||
<!-- C++/CLI event --> |
||||
<xsd:attribute name="add" type="DoxBool" use="optional"/> |
||||
<xsd:attribute name="remove" type="DoxBool" use="optional"/> |
||||
<xsd:attribute name="raise" type="DoxBool" use="optional"/> |
||||
<!-- Objective-C 2.0 protocol method --> |
||||
<xsd:attribute name="optional" type="DoxBool" use="optional"/> |
||||
<xsd:attribute name="required" type="DoxBool" use="optional"/> |
||||
<!-- Objective-C 2.0 property accessor --> |
||||
<xsd:attribute name="accessor" type="DoxAccessor" use="optional"/> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="descriptionType" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="title" type="xsd:string" minOccurs="0"/> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="internal" type="docInternalType" minOccurs="0" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="enumvalueType" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="name" /> |
||||
<xsd:element name="initializer" type="linkedTextType" minOccurs="0" /> |
||||
<xsd:element name="briefdescription" type="descriptionType" minOccurs="0" /> |
||||
<xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="id" type="xsd:string" /> |
||||
<xsd:attribute name="prot" type="DoxProtectionKind" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="templateparamlistType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="paramType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="type" type="linkedTextType" minOccurs="0" /> |
||||
<xsd:element name="declname" minOccurs="0" /> |
||||
<xsd:element name="defname" minOccurs="0" /> |
||||
<xsd:element name="array" minOccurs="0" /> |
||||
<xsd:element name="defval" type="linkedTextType" minOccurs="0" /> |
||||
<xsd:element name="briefdescription" type="descriptionType" minOccurs="0" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="linkedTextType" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="graphType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="node" type="nodeType" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="nodeType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="label" /> |
||||
<xsd:element name="link" type="linkType" minOccurs="0" /> |
||||
<xsd:element name="childnode" type="childnodeType" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="id" type="xsd:string" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="childnodeType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="edgelabel" minOccurs="0" maxOccurs="unbounded"/> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="refid" type="xsd:string" /> |
||||
<xsd:attribute name="relation" type="DoxGraphRelation" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="linkType"> |
||||
<xsd:attribute name="refid" type="xsd:string" /> |
||||
<xsd:attribute name="external" type="xsd:string" use="optional"/> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="listingType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="codeline" type="codelineType" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="codelineType"> |
||||
<xsd:sequence> |
||||
<xsd:element name="highlight" type="highlightType" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="lineno" type="xsd:integer" /> |
||||
<xsd:attribute name="refid" type="xsd:string" /> |
||||
<xsd:attribute name="refkind" type="DoxRefKind" /> |
||||
<xsd:attribute name="external" type="DoxBool" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="highlightType" mixed="true"> |
||||
<xsd:choice minOccurs="0" maxOccurs="unbounded"> |
||||
<xsd:element name="sp" /> |
||||
<xsd:element name="ref" type="refTextType" /> |
||||
</xsd:choice> |
||||
<xsd:attribute name="class" type="DoxHighlightClass" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="referenceType" mixed="true"> |
||||
<xsd:attribute name="refid" type="xsd:string" /> |
||||
<xsd:attribute name="compoundref" type="xsd:string" use="optional" /> |
||||
<xsd:attribute name="startline" type="xsd:integer" /> |
||||
<xsd:attribute name="endline" type="xsd:integer" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="locationType"> |
||||
<xsd:attribute name="file" type="xsd:string" /> |
||||
<xsd:attribute name="line" type="xsd:integer" /> |
||||
<xsd:attribute name="bodyfile" type="xsd:string" /> |
||||
<xsd:attribute name="bodystart" type="xsd:integer" /> |
||||
<xsd:attribute name="bodyend" type="xsd:integer" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="docSect1Type" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="title" type="xsd:string" /> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="internal" type="docInternalS1Type" minOccurs="0" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="id" type="xsd:string" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="docSect2Type" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="title" type="xsd:string" /> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="internal" type="docInternalS2Type" minOccurs="0" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="id" type="xsd:string" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="docSect3Type" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="title" type="xsd:string" /> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="sect4" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="internal" type="docInternalS3Type" minOccurs="0" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="id" type="xsd:string" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="docSect4Type" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="title" type="xsd:string" /> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="internal" type="docInternalS4Type" minOccurs="0" /> |
||||
</xsd:sequence> |
||||
<xsd:attribute name="id" type="xsd:string" /> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="docInternalType" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="docInternalS1Type" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="docInternalS2Type" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="docInternalS3Type" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
<xsd:element name="sect3" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:complexType name="docInternalS4Type" mixed="true"> |
||||
<xsd:sequence> |
||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> |
||||
</xsd:sequence> |
||||
</xsd:complexType> |
||||
|
||||
<xsd:group name="docTitleCmdGroup"> |
||||
<xsd:choice> |
||||
<xsd:element name="ulink" type="docURLLink" /> |
||||
<xsd:element name="bold" type="docMarkupType" /> |
||||
<xsd:element name="emphasis" type="docMarkupType" /> |
||||
<xsd:element name="computeroutput" type="docMarkupType" /> |
||||