https://github.com/shannah/xataface-docs

Repo for legacy xataface docs
https://github.com/shannah/xataface-docs

Last synced: 9 days ago
JSON representation

Repo for legacy xataface docs

• Host: GitHub
• URL: https://github.com/shannah/xataface-docs
• Owner: shannah
• Created: 2016-11-17T17:06:10.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-09-09T23:23:29.000Z (over 5 years ago)
• Last Synced: 2024-12-24T05:04:58.573Z (18 days ago)
• Language: JavaScript
• Size: 2.27 MB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Xataface Documentation

This project includes documentation for [Xataface](http://xataface.com).  PHP API docs are generated using [Doxygen](http://www.stack.nl/~dimitri/doxygen/), 

while Javascript docs are generated using [JSdoc](http://usejsdoc.org/), which is bundled in the build_tools directory.

There is also a directory containing some documentation in markdown format in the markdown-docs directory.  This documentation will eventually

be moved to the [Xataface Wiki](https://github.com/shannah/xataface/wiki) on GitHub.

## Generating the Docs

### Requirements

1. Java 1.7 or higher

2. ANT 1.8 or higher

3. Doxygen 1.7 or higher

This project includes a build.xml file with some key tasks:

~~~~

$ ant -p

Buildfile: /Applications/XAMPP/xamppfiles/htdocs/xataface-docs/build.xml

Main targets:

 all      Generate All Documentation

 doxygen  Generate Doxygen Docs

 jsdoc    Generate jsdoc documentation

Default target: all

~~~~

To build all docs, simply run:

~~~~

$ ant

~~~~

NOTE:  You will likely need to provide the path to doxygen as follows:

~~~~

$ ant -Ddoxygen=/path/to/doxygen

~~~~

The hard-coded path in the build file points to the location on my build machine.

Docs will be generated inside the build directory.