0ip
7ee42edcf1
Document 'lang' Parameter
2012-11-14 17:21:45 +01:00
Marcel Klehr
6a027a1c2c
[docs] Document custom static files.
2012-11-01 14:48:19 +01:00
yourcelf
13cef386f8
Add api docs for userColor query arg
2012-10-31 16:28:12 -03:00
Marcel Klehr
f676e90199
[docs] Fix assets: Rename doc/_assets to doc/assets
...
github's jekyll would do some dark magic with '_assets'.
We don't want that.
2012-10-31 18:12:12 +01:00
Marcel Klehr
dd1e383d6e
Bump api version in #usage section
2012-10-30 14:35:26 +01:00
Marcel Klehr
ef923209b0
Refactor structure of api/http_api.md and add api version numbers for all endpoints.
2012-10-30 14:18:50 +01:00
John McLear
4afc9ccbdf
Merge pull request #1094 from marcelklehr/fix/doc-generator
...
Change filename hooks.md -> hooks_overview.md
2012-10-29 06:36:56 -07:00
Marcel Klehr
7a8401c363
Add recipe for doc assets and some basic styling for the generated docs.
2012-10-27 18:47:09 +02:00
Marcel Klehr
3d1fd05085
Insert epl version into template.
2012-10-27 17:28:15 +02:00
Marcel Klehr
94e399e8a9
Change filename hooks.md -> hooks_overview.md
...
so it doesn't confuse tools/doc/generator
2012-10-27 16:30:31 +02:00
Marcel Klehr
63e4aafae8
Add docs for plugins and plugin framework
...
@redhog please elaborate on / improve 'doc/api/pluginfw.md'!
2012-10-25 15:45:06 +02:00
John McLear
db1a1a0e3e
Merge pull request #1034 from d-a-n/develop
...
Added hooks for pad events create/edit/load/remove
2012-10-05 17:28:40 -07:00
d-a-n
0fd8490ca6
Changed pad_id to padID to follow projct standards.
2012-10-03 15:49:28 +03:00
d-a-n
754c559d63
Changed pad hook names to follow naming conventions.
2012-10-03 13:35:31 +03:00
Marcel Klehr
2684a1d295
Merge branch 'develop' into express-v3
...
Conflicts:
src/node/hooks/express/errorhandling.js
2012-10-03 10:09:00 +02:00
d-a-n
4652751285
Updated docs for new pad hooks (add, edit, remove)
2012-10-02 22:32:30 +03:00
d-a-n
c0f2e557d3
Updated docs for new pad hooks (add, edit, remove)
2012-10-02 22:11:54 +03:00
d-a-n
07c33c77c4
Updated docs for new pad hooks (add, edit, remove)
2012-10-02 22:10:18 +03:00
Gedion
6009903095
added comments to ace exposed methods
2012-10-01 19:18:19 -05:00
Gedion
61022be6e4
added comments to ace exposed methods
2012-10-01 19:14:27 -05:00
Gedion
3fe3df91ae
update docs for new hooks and ace exposures
2012-09-30 17:13:14 -05:00
Marcel Klehr
1c38f5bab9
Update docs
2012-09-22 16:04:30 +02:00
Marcel Klehr
4416210471
Differentiate between http server and express app
2012-09-21 17:12:22 +02:00
Marcel Klehr
f8f002adc0
Add listAllGroups API endpoint
...
Adds a database key that lists all groups
2012-09-17 23:03:56 +02:00
Marcel Klehr
40572b13b9
Document, how return values of hooks are handled.
2012-09-12 17:15:38 +02:00
Marcel Klehr
eeb605334f
Add in docs for getAuthorName API method
2012-09-06 12:13:41 +02:00
Marcel Klehr
8a696ab77d
Expect a comma seperated list of sessionIDs in session cookie
...
This allows people to be active on more than one group.
2012-09-02 19:51:12 +02:00
Mark Holmquist
f9469ef256
Add in padUsers HTTP API call
...
I needed the list of users this time, so I got it. There are docs
and everything.
2012-08-17 13:39:16 -07:00
Marcel Klehr
1bb8844f42
Document loadSettings hook.
2012-08-15 10:10:55 +02:00
Mark Holmquist
17375b2eed
Fix doc format, add in makefile for docs
...
OK, first up, SOMEBODY *cough*analphabet*cough* screwed up the docs
by making them all use the wrong heading level. Not cool, guy. I
had to change them so they would compile right.
But anyway, now the docs will build into sexy-looking HTML and will
shortly be hosted on marktraceur.info.
Fixed the makefile to work properly.
Run:
* `make clean` for removing old doc-build(s)
* `make docs` for running new doc-build(s)
2012-08-13 21:11:39 -07:00
Marcel Klehr
98cdb96ac3
Document 'documentReady' client hook.
2012-08-12 21:29:21 +02:00
John McLear
838834f438
Merge pull request #930 from MarkTraceur/new-doc/http/send-clients-message
...
Added in docs for the HTTP call I just added
2012-08-12 09:09:20 -07:00
John McLear
aabdf665a7
Merge pull request #934 from MarkTraceur/new-doc/plugin/handle-client-message
...
Add in docs for the new hook I just added
2012-08-12 08:55:44 -07:00
Mark Holmquist
14da09dddd
Add in docs for the new hook I just added
2012-08-10 09:49:43 -07:00
Marcel Klehr
453c68da19
Add doc generator.
2012-08-08 20:56:56 +02:00
Mark Holmquist
e491476a0f
Added in docs for the HTTP call I just added
2012-08-08 10:26:18 -07:00
Marcel Klehr
db4ae500a1
Fix markup.
2012-08-07 20:29:44 +02:00
Marcel Klehr
7e2820a674
Remove file endings from includes.
2012-08-07 20:21:11 +02:00
Marcel Klehr
70fb765118
Restructure headings.
2012-08-07 20:19:37 +02:00
Marcel Klehr
5fac05a395
Add docs.
2012-08-03 22:04:06 +02:00
Peter 'Pita' Martischka
3c8ee3df20
removed docs created with doc.md, these docs were completly useless
2011-12-04 17:12:27 +01:00
Peter 'Pita' Martischka
e79f29f67d
removed 'planed' from the database documentation
2011-08-21 20:49:07 +01:00
Peter 'Pita' Martischka
dbf9dc6dfb
added listSessionsOfGroup and listSessionsOfAuthor
2011-08-09 20:14:32 +01:00
Peter 'Pita' Martischka
212cf83a25
updated the database doc
2011-08-08 17:33:25 +01:00
Peter 'Pita' Martischka
31067f163f
added a documentation for the database structure
2011-08-03 12:09:19 +01:00
Peter 'Pita' Martischka
8ca57ffde4
Added READMEs to explain the doc folders
2011-08-01 19:29:22 +01:00
Peter 'Pita' Martischka
0772f6bb4e
updated documentation
2011-07-30 17:25:54 +01:00
Peter 'Pita' Martischka
c4325a050f
Beautify the docs
2011-05-30 16:05:42 +01:00
Peter 'Pita' Martischka
f7b46f6e69
Documentation
2011-05-30 15:53:11 +01:00
Peter 'Pita' Martischka
7024f3e78a
Replace JSDoc-Toolkit with doc.md
2011-05-29 21:30:56 +01:00
Peter 'Pita' Martischka
e2ce9dcc02
reorganize Joes PDF's
2011-04-07 14:45:19 +01:00
Peter 'Pita' Martischka
31952532c2
Uploaded improved documentation about easysync, thx @Joe Corneli
2011-03-28 13:30:42 +01:00
Peter 'Pita' Martischka
9360814242
Created a JSDoc, first try
2011-03-27 12:49:56 +01:00
Peter 'Pita' Martischka
bf15ebe073
Adding some documentation about easysync - Thx to Joe Corneli
2011-03-26 15:32:25 +00:00
Peter 'Pita' Martischka
437cd90b90
Removing unused files
2011-03-26 13:49:01 +00:00
Peter 'Pita' Martischka
325c322a27
first-commit
2011-03-26 13:10:41 +00:00
