From 300d1ad44e81ff832d622e5e4137995f1649c7f6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= <flashcode@flashtux.org>
Date: Sat, 7 Mar 2015 15:16:37 +0100
Subject: doc: add Javascript plugin in docs

---
 doc/en/weechat_dev.en.asciidoc | 65 +++++++++++++++++++++++-------------------
 1 file changed, 35 insertions(+), 30 deletions(-)

(limited to 'doc/en/weechat_dev.en.asciidoc')

diff --git a/doc/en/weechat_dev.en.asciidoc b/doc/en/weechat_dev.en.asciidoc
index 976bb9471..6a2e2260b 100644
--- a/doc/en/weechat_dev.en.asciidoc
+++ b/doc/en/weechat_dev.en.asciidoc
@@ -46,35 +46,36 @@ The main WeeChat directories are:
 
 [width="100%",cols="1v,5",options="header"]
 |===
-| Directory      | Description
-| src/           | Root of sources
-|    core/       | Core functions: entry point, internal structures
-|    gui/        | Functions for buffers, windows, ... (used by all interfaces)
-|       curses/  | Curses interface
-|    plugins/    | Plugin and scripting API
-|       alias/   | Alias plugin
-|       aspell/  | Aspell plugin
-|       charset/ | Charset plugin
-|       exec/    | Exec plugin
-|       fifo/    | Fifo plugin (FIFO pipe used to remotely send commands to WeeChat)
-|       irc/     | IRC (Internet Relay Chat) plugin
-|       logger/  | Logger plugin (write messages displayed to files)
-|       relay/   | Relay plugin (irc proxy + relay for remote interfaces)
-|       script/  | Scripts manager
-|       python/  | Python scripting API
-|       perl/    | Perl scripting API
-|       ruby/    | Ruby scripting API
-|       lua/     | Lua scripting API
-|       tcl/     | Tcl scripting API
-|       guile/   | Guile (scheme) scripting API
-|       trigger/ | Trigger plugin
-|       xfer/    | Xfer plugin (IRC DCC file/chat)
-| tests/         | Tests
-|    unit/       | Unit tests
-|       core/    | Unit tests for core functions
-| doc/           | Documentation
-| po/            | Translations files (gettext)
-| debian/        | Debian packaging
+| Directory         | Description
+| src/              | Root of sources
+|    core/          | Core functions: entry point, internal structures
+|    gui/           | Functions for buffers, windows, ... (used by all interfaces)
+|       curses/     | Curses interface
+|    plugins/       | Plugin and scripting API
+|       alias/      | Alias plugin
+|       aspell/     | Aspell plugin
+|       charset/    | Charset plugin
+|       exec/       | Exec plugin
+|       fifo/       | Fifo plugin (FIFO pipe used to remotely send commands to WeeChat)
+|       irc/        | IRC (Internet Relay Chat) plugin
+|       logger/     | Logger plugin (write messages displayed to files)
+|       relay/      | Relay plugin (irc proxy + relay for remote interfaces)
+|       script/     | Scripts manager
+|       python/     | Python scripting API
+|       perl/       | Perl scripting API
+|       ruby/       | Ruby scripting API
+|       lua/        | Lua scripting API
+|       tcl/        | Tcl scripting API
+|       guile/      | Guile (scheme) scripting API
+|       javascript/ | Javascript scripting API
+|       trigger/    | Trigger plugin
+|       xfer/       | Xfer plugin (IRC DCC file/chat)
+| tests/            | Tests
+|    unit/          | Unit tests
+|       core/       | Unit tests for core functions
+| doc/              | Documentation
+| po/               | Translations files (gettext)
+| debian/           | Debian packaging
 |===
 
 [[sources]]
@@ -215,6 +216,10 @@ WeeChat "core" is located in following directories:
 |       irc-sasl.c                  | SASL authentication with IRC server
 |       irc-server.c                | I/O communication with IRC server
 |       irc-upgrade.c               | Save/restore of IRC data when upgrading WeeChat
+|    javascript/                    | Javascript plugin
+|       weechat-js.cpp              | Main javascript functions (load/unload scripts, execute javascript code)
+|       weechat-js-api.cpp          | Javascript scripting API functions
+|       weechat-js-v8.cpp           | Javascript v8 functions
 |    logger/                        | Logger plugin
 |       logger.c                    | Main logger functions
 |       logger-buffer.c             | Logger buffer list management
@@ -1031,7 +1036,7 @@ Then you can load this script in your WeeChat, and setup path to your '/doc' dir
 Then create this alias to build files:
 
 ----
-/alias doc /perl unload; /python unload; /ruby unload; /lua unload; /tcl unload; /guile unload; /python load docgen.py; /wait 1ms /docgen
+/alias doc /perl unload; /python unload; /ruby unload; /lua unload; /tcl unload; /guile unload; /javascript unload; /python load docgen.py; /wait 1ms /docgen
 ----
 
 And use command `/doc` to build all files, for all languages.
-- 
cgit v1.2.3

