[Pkg-voip-commits] [janus] 152/163: Ugly hack to fix nits (double dashes) in documentation

Jonas Smedegaard dr at jones.dk
Sat Oct 28 01:22:25 UTC 2017


This is an automated email from the git hooks/post-receive script.

js pushed a commit to annotated tag debian/0.2.5-1
in repository janus.

commit 9e55e3da35f29ea10063570cc4dfa6a7399765c3
Author: Lorenzo Miniero <lminiero at gmail.com>
Date:   Fri Oct 20 18:39:46 2017 +0200

    Ugly hack to fix nits (double dashes) in documentation
---
 docs/doxy-boot.js |  2 ++
 mainpage.dox      | 16 +++++++++-------
 2 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/docs/doxy-boot.js b/docs/doxy-boot.js
index 46f0566..d13a550 100644
--- a/docs/doxy-boot.js
+++ b/docs/doxy-boot.js
@@ -61,4 +61,6 @@ $(document).ready(function() {
 	$('div.groupHeader').addClass('alert-link').parent().parent().addClass('alert alert-info');
 	
 	$('#MSearchBox').remove();//.parent().appendTo('#topmenu');
+
+	$('code').each(function() { $(this).html($(this).html().replace("–", "--")); } );
 });
diff --git a/mainpage.dox b/mainpage.dox
index d45f5b7..0fbdc87 100644
--- a/mainpage.dox
+++ b/mainpage.dox
@@ -617,7 +617,7 @@ janus.attach(
  *    incurring the overhead of a full build of the Janus Gateway.
  *
  * \section auto-build-js-modules Building modules using make
- * Each supported variant may be enabled by passing a corresponding \c ––enable-javascript-*-module flag
+ * Each supported variant may be enabled by passing a corresponding \c --enable-javascript-*-module flag
  * (with or without a \c =yes directive) to \c configure before invoking \c make to build the Janus Gateway.
  * Please note: if you do not pass any such flag, by default no modules will be built.
  *
@@ -625,12 +625,14 @@ janus.attach(
  *
  * <table class="table table-striped">
  * <tr><th>Module format (syntax)</th><th>File name</th><th>configure flag to pass</th></tr>
- * <tr><td>ECMAScript</td><td>janus.es.js</td><td>\c ––enable-javascript-es-module</td></tr>
- * <tr><td>Universal Module Definition (UMD)</td><td>janus.umd.js</td><td>\c ––enable-javascript-umd-module</td></tr>
- * <tr><td>CommonJS</td><td>janus.cjs.js</td><td>\c ––enable-javascript-common-js-module</td></tr>
- * <tr><td>Immediately Invoked Function Expression (IIFE)</td><td>janus.iife.js</td><td>\c ––enable-javascript-iffe-module</td></tr>
+ * <tr><td>ECMAScript</td><td>janus.es.js</td><td>\c --enable-javascript-es-module</td></tr>
+ * <tr><td>Universal Module Definition (UMD)</td><td>janus.umd.js</td><td>\c --enable-javascript-umd-module</td></tr>
+ * <tr><td>CommonJS</td><td>janus.cjs.js</td><td>\c --enable-javascript-common-js-module</td></tr>
+ * <tr><td>Immediately Invoked Function Expression (IIFE)</td><td>janus.iife.js</td><td>\c --enable-javascript-iffe-module</td></tr>
  * </table>
  *
+ * The \c --enable-all-js-modules shortcut is available, in case you want to enable and build them all.
+ *
  * When built and installed, these module variants may be found in the \c $PREFIX/share/janus/javascript
  * folder, alongside the \c janus.js file itself (assuming \c $PREFIX the installation directory passed to \c configure).
  *
@@ -2366,11 +2368,11 @@ var servers = [ws_server, http_server];
  *
  * \section daemon Running Janus as a daemon
  * Since version \c 0.1.0, you can run Janus as a daemon application. To
- * do so, just pass either \c -b or <code>\--daemon</code> as a command line
+ * do so, just pass either \c -b or \c --daemon as a command line
  * argument, and Janus will be daemonized. Just beware, though, that
  * since this results in stdout/stdin/stderr being closed, you MUST
  * specify a log file for Janus to use, either via command line (\c -L
- * or <code>\--log-file</code>) or in \c janus.cfg.
+ * or \c --log-file ) or in \c janus.cfg.
  *
  * \section bg Running in background
  * Another simple way to run Janus in the background is to just append the

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-voip/janus.git



More information about the Pkg-voip-commits mailing list