Skip to content

Commit

Permalink
Documentation fixes (no code changes)
Browse files Browse the repository at this point in the history
  • Loading branch information
@manuel-serrano
manuel-serrano committed Jan 31, 2025
1 parent f88abce commit 6c4cf21
Show file tree
Hide file tree
Showing 58 changed files with 256 additions and 292 deletions.
4 changes: 2 additions & 2 deletions doc/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#* ------------------------------------------------------------- */
#* Author : Manuel Serrano */
#* Creation : Fri Jan 20 13:46:40 2006 */
#* Last change : Thu Jan 30 11:31:18 2025 (serrano) */
#* Last change : Thu Jan 30 13:11:50 2025 (serrano) */
#* Copyright : 2006-25 Manuel Serrano */
#* ------------------------------------------------------------- */
#* Doc Makefile */
Expand Down Expand Up @@ -94,7 +94,7 @@ VPATH=api lang dev widget intf \
../node_modules/@hop/markdown/doc \
../node_modules/syslog/doc \
../node_modules/system/doc \
../node_modules/utils/doc \
../node_modules/@hop/utils/doc \
../node_modules/texinfo/doc \
../node_modules/csv/doc \
../node_modules/text/doc \
Expand Down
2 changes: 1 addition & 1 deletion doc/api/00-hop.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require("hopdoc") }
${ var doc = require("@hop/hopdoc") }

Hop
===
Expand Down
2 changes: 1 addition & 1 deletion doc/api/01-html.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }

HTML
====
Expand Down
2 changes: 1 addition & 1 deletion doc/api/10-dom.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }

Dom
===
Expand Down
2 changes: 1 addition & 1 deletion doc/api/20-websocket.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require("hopdoc") }
${ var doc = require("@hop/hopdoc") }

WebSockets
==========
Expand Down
2 changes: 1 addition & 1 deletion doc/api/api.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"../node_modules/syslog/doc/syslog.md",
"../node_modules/systime/doc/systime.md",
"../node_modules/system/doc/system.md",
"../node_modules/utils/doc/utils.md",
"../node_modules/@hop/utils/doc/utils.md",
[],
"../node_modules/@hop/markdown/doc/markdown.md",
"../node_modules/cpp/doc/cpp.md",
Expand Down
3 changes: 1 addition & 2 deletions doc/bib.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var config = require( hop.config ) }
${ var doc = require( "@hop/hopdoc" ) }
${ var xml = require( doc.BUILDDIR + "/doc/xml.js" ) }
${ var cfg = require( doc.BUILDDIR + "/doc/doc.json" ) }
${ var bibtex = require( "./_bibtex.hop" ) }
Expand Down
3 changes: 1 addition & 2 deletions doc/dev/01-rcfile.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
${var hop = require( "hop" )}
${var hopdoc = require( "hopdoc" )}
${var hopdoc = require( "@hop/hopdoc" )}


### RC file ###
Expand Down
3 changes: 1 addition & 2 deletions doc/dev/10-edit.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
${var hop = require( "hop" )}
${var hopdoc = require( "hopdoc" )}
${var hopdoc = require( "@hop/hopdoc" )}


### Emacs ###
Expand Down
3 changes: 1 addition & 2 deletions doc/dev/20-cross.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
${var hop = require( "hop" )}
${var hopdoc = require( "hopdoc" )}
${var hopdoc = require( "@hop/hopdoc" )}


### Cross-compiling Hop ###
Expand Down
3 changes: 1 addition & 2 deletions doc/dev/25-android.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
${var hop = require( "hop" )}
${var hopdoc = require( "hopdoc" )}
${var hopdoc = require( "@hop/hopdoc" )}
${hopdoc.setSource(module.filename)}

${hopdoc.include( "../../arch/android/README.md" )}
Expand Down
3 changes: 1 addition & 2 deletions doc/dev/30-https.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
${var hop = require( "hop" )}
${var doc = require( "hopdoc" )}
${var doc = require( "@hop/hopdoc" )}


https
Expand Down
3 changes: 1 addition & 2 deletions doc/dev/90-hopc.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
${var hop = require("hop")}
${var doc = require("hopdoc")}
${var doc = require("@hop/hopdoc")}


Hopc Development
Expand Down
10 changes: 5 additions & 5 deletions doc/doc.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
/* ------------------------------------------------------------- */
/* Author : Manuel Serrano */
/* Creation : Thu Jul 30 17:20:13 2015 */
/* Last change : Sun Nov 10 18:12:33 2024 (serrano) */
/* Copyright : 2015-24 Manuel Serrano */
/* Last change : Fri Jan 31 07:10:54 2025 (serrano) */
/* Copyright : 2015-25 Manuel Serrano */
/* ------------------------------------------------------------- */
/* Tools to build the Hop.js documentation. */
/*=====================================================================*/
Expand All @@ -15,9 +15,9 @@
/*---------------------------------------------------------------------*/
const path = require("path");
const fs = require("fs");
const markdown = require(hop.markdown);
const fontifier = require(hop.fontifier);
const hopdoc = require("hopdoc")
const markdown = require("@hop/markdown");
const fontifier = require("@hop/fontifier");
const hopdoc = require("@hop/hopdoc")
const docxml = require("./xml.js");

/*---------------------------------------------------------------------*/
Expand Down
3 changes: 1 addition & 2 deletions doc/download.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<!-- ${ var doc = require( "hopdoc" );
var config = require( hop.config );
<!-- ${ var doc = require( "@hop/hopdoc" );
var xml = require( doc.BUILDDIR + "/doc/xml.js" );
var cfg = require( doc.BUILDDIR + "/doc/doc.json" ) } -->

Expand Down
2 changes: 1 addition & 1 deletion doc/intf/10-scheme.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }
${ var path = require( "path" ) }
${ var ROOT = path.dirname( module.filename ) }

Expand Down
2 changes: 1 addition & 1 deletion doc/intf/20-language.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }
${ var path = require( "path" ) }
${ var ROOT = path.dirname( module.filename ) }

Expand Down
2 changes: 1 addition & 1 deletion doc/lang/00-syntax.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }
${ var path = require( "path" ) }
${ var ROOT = path.dirname( module.filename ) }

Expand Down
2 changes: 1 addition & 1 deletion doc/lang/01-module.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }

HopScript Modules
=================
Expand Down
2 changes: 1 addition & 1 deletion doc/lang/01-service.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }
${ var path = require( "path" ) }
${ var ROOT = path.dirname( module.filename ) }

Expand Down
2 changes: 1 addition & 1 deletion doc/lang/02-worker.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }

Server-side Workers
===================
Expand Down
2 changes: 1 addition & 1 deletion doc/lang/03-react.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }

Web Reactive Programming
========================
Expand Down
2 changes: 1 addition & 1 deletion doc/lang/10-xml.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }

XML
===
Expand Down
2 changes: 1 addition & 1 deletion doc/license.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
${ var doc = require( "hopdoc" ) }
${ var doc = require( "@hop/hopdoc" ) }
${ var xml = require( doc.BUILDDIR + "/doc/xml.js" ) }

HOP, a web development kit - copyright (c) ${xml.copyrightYears( 2006 )} INRIA
Expand Down
77 changes: 77 additions & 0 deletions node_modules/@hop/hopdoc/hop/_hopdoc.hop
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 26 additions & 10 deletions node_modules/hopdoc/lib/hopdoc.js → node_modules/@hop/hopdoc/hop/hopdoc.mjs
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 node_modules/hopdoc/hss/hopdoc.hss → node_modules/@hop/hopdoc/hss/hopdoc.hss
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion node_modules/hopdoc/package.json → node_modules/@hop/hopdoc/package.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions node_modules/@hop/hopdoc/type/hopdoc.d.ts
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 node_modules/utils/doc/utils.md → node_modules/@hop/utils/doc/utils.md
View file
File renamed without changes.
Loading

0 comments on commit 6c4cf21

Please sign in to comment.