Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
G
Gxml
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Canek Peláez Valdés
Gxml
Commits
4caf84e1
Commit
4caf84e1
authored
7 years ago
by
Daniel Espinosa
Browse files
Options
Downloads
Patches
Plain Diff
README: Updated for Autotools, Meson and documentation
parent
314dda03
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
README
+44
-5
44 additions, 5 deletions
README
gxml.doap
+1
-1
1 addition, 1 deletion
gxml.doap
with
45 additions
and
6 deletions
README
+
44
−
5
View file @
4caf84e1
GXml is a GObject API that wraps around libxml2.
GXml provides a GObject API for manipulating XML and a Serializable
framework from GObject to XML.
GXml provide a DOM level 4 API for XML with multiple backends.
* A backend wrapping around libxml2 for read/write, the GNode class series
* A GObject based tree backend, a more closed DOM4 implementation support is present,
the GomNode class series.
There is a GObject based tree backend, using libxml2 just to read XML files,
the TNode [Unmaintained], offering just DOM leve 1 API.
Compile:
Compile:
Requirements:
Requirements:
* vala
* libxml2
Optional Requirements:
* valadoc: we generate documentation using valadoc. If it's not
* valadoc: we generate documentation using valadoc. If it's not
packaged for your distro (like Fedora) follow the instructions
packaged for your distro (like Fedora) follow the instructions
at:
at:
https://live.gnome.org/Valadoc
https://live.gnome.org/Valadoc
a
utotools
for a
build system
A
utotools build system
:
$ ./configure
$ ./configure
$ ./make
$ make
$ ./make install
$ make install
Meson build system:
$ meson _build
$ cd _build
$ ninja
$ ninja install
You can use some common ./configure options like --prefix=$SOMEPATH to specify
You can use some common ./configure options like --prefix=$SOMEPATH to specify
where to install it.
where to install it.
...
@@ -25,6 +46,14 @@ Test: You can run the test suite, which is gxml_test, which you may
...
@@ -25,6 +46,14 @@ Test: You can run the test suite, which is gxml_test, which you may
$ cd test/
$ cd test/
$ ./gxml_test
$ ./gxml_test
Autotools build system:
$ make test
Meson build system:
$ meson test
Writing documentation
Writing documentation
...
@@ -33,6 +62,12 @@ Writing documentation
...
@@ -33,6 +62,12 @@ Writing documentation
solution to generate both valadoc documentation and HTML gtk-doc
solution to generate both valadoc documentation and HTML gtk-doc
documentation.
documentation.
Installation for DevHelp:
Make sure you have valadoc installed, documentation is automatically
generated, then install it, your documentation will be available in
DevHelp.
Some notes:
Some notes:
- Documentation for overriding functions/methods is shown in
- Documentation for overriding functions/methods is shown in
...
@@ -53,7 +88,11 @@ Writing documentation
...
@@ -53,7 +88,11 @@ Writing documentation
- Multiline descriptions will only have the first line appear in
- Multiline descriptions will only have the first line appear in
valadoc.
valadoc.
- For the gtkdoc to be visible in devhelp and you're installing into
- For the gtkdoc
or valadoc
to be visible in devhelp and you're installing into
an abnormal prefix, consider placing a symlink to your prefix
an abnormal prefix, consider placing a symlink to your prefix
installed gtk-doc in /usr/share/gtk-doc/html/. For example,
installed gtk-doc in /usr/share/gtk-doc/html/. For example,
$ ln -s ~/.local/share/gtk-doc/html/gxml /usr/share/gtk-doc/html
$ ln -s ~/.local/share/gtk-doc/html/gxml /usr/share/gtk-doc/html
- Valadoc's documentation use JavaScript to naviate over inherited
methods and properties, but DevHelp have no support for that.
TODO: write a patch to DevHelp to support Valadoc's JavaScript
This diff is collapsed.
Click to expand it.
gxml.doap
+
1
−
1
View file @
4caf84e1
...
@@ -9,7 +9,7 @@
...
@@ -9,7 +9,7 @@
<description>GXml provides a GObject API for manipulating XML and a Serializable
<description>GXml provides a GObject API for manipulating XML and a Serializable
framework from GObject to XML.
framework from GObject to XML.
Currently, GXml provides the DOM Level
1
Core API, Basic HTML support, Serialization.
Currently, GXml provides the DOM Level
4 like
Core API, Basic HTML support, Serialization.
Provides a set of interfaces to access XML equivalent files with different
Provides a set of interfaces to access XML equivalent files with different
implementations, some of them based on libxml but able to use different backends.
implementations, some of them based on libxml but able to use different backends.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment