rvirding · davydog187 · Sep 28, 2024 · Sep 28, 2024 · Sep 28, 2024 · Sep 29, 2024
diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@ src/luerl_scan.erl
 src/luerl_parse.erl
 comp_opts.mk
 doc/epub/*
+doc
 ebin/*.beam
 log
 logs

diff --git a/doc/luerl.txt → doc_legacy/luerl.txt b/doc/luerl.txt → doc_legacy/luerl.txt
diff --git a/doc/luerl_new.txt → doc_legacy/luerl_new.txt b/doc/luerl_new.txt → doc_legacy/luerl_new.txt
diff --git a/doc/luerl_sandbox.txt → doc_legacy/luerl_sandbox.txt b/doc/luerl_sandbox.txt → doc_legacy/luerl_sandbox.txt
diff --git a/doc/man/luerl.3 → doc_legacy/man/luerl.3 b/doc/man/luerl.3 → doc_legacy/man/luerl.3
diff --git a/doc/man/luerl_new.3 → doc_legacy/man/luerl_new.3 b/doc/man/luerl_new.3 → doc_legacy/man/luerl_new.3
diff --git a/doc/man/luerl_sandbox.3 → doc_legacy/man/luerl_sandbox.3 b/doc/man/luerl_sandbox.3 → doc_legacy/man/luerl_sandbox.3
diff --git a/doc/pdf/luerl.pdf → doc_legacy/pdf/luerl.pdf b/doc/pdf/luerl.pdf → doc_legacy/pdf/luerl.pdf
diff --git a/doc/pdf/luerl_new.pdf → doc_legacy/pdf/luerl_new.pdf b/doc/pdf/luerl_new.pdf → doc_legacy/pdf/luerl_new.pdf
diff --git a/doc/pdf/luerl_sandbox.pdf → doc_legacy/pdf/luerl_sandbox.pdf b/doc/pdf/luerl_sandbox.pdf → doc_legacy/pdf/luerl_sandbox.pdf
diff --git a/doc/src/luerl.3.md → doc_legacy/src/luerl.3.md b/doc/src/luerl.3.md → doc_legacy/src/luerl.3.md
diff --git a/doc/src/luerl_new.3.md → doc_legacy/src/luerl_new.3.md b/doc/src/luerl_new.3.md → doc_legacy/src/luerl_new.3.md
diff --git a/doc/src/luerl_sandbox.3.md → doc_legacy/src/luerl_sandbox.3.md b/doc/src/luerl_sandbox.3.md → doc_legacy/src/luerl_sandbox.3.md
diff --git a/rebar.config b/rebar.config
@@ -8,18 +8,6 @@
     {apps, [luerl]}
 ]}.
 
-{relx, [{release, {luerl, "1.2.2"},
-         [kernel,
-          stdlib,
-          sasl,
-          inets,
-          luerl]},
-
-        {dev_mode, false},
-        {include_erts, true},
-
-        {extended_start_script, true}]}.
-
 {profiles, [
   {test, [
     {dist_node, [
@@ -29,3 +17,15 @@
     {ct_opts, [{logdir, "logs"}]}
   ]}
 ]}.
+
+{project_plugins, [rebar3_hex, rebar3_ex_doc]}.
+
+{hex, [
+    {doc, #{provider => ex_doc}}
+]}.
+
+{ex_doc, [
+    {source_url, <<"https://github.com/rvirding/luerl">>},
+    {extras, [<<"README.md">>, <<"LICENSE">>]},
+    {main, <<"readme">>}
+]}.
diff --git a/src/luerl.app.src b/src/luerl.app.src
@@ -25,9 +25,5 @@
   %% Project metadata
   {licenses, ["Apache-2.0"]},
   {links, [{"Github", "https://github.com/rvirding/luerl"}]},
-  %% This is used for hex packages.
-  {files, ["README.md", "LICENSE", "VERSION", "src", "doc", "ebin/luerl.app",
-           "include", "rebar.*", "*akefile",
-           "*.escript"]},
-  {exclude_files, ["priv/images/*"]}
+  {doc, "doc"}
  ]}.
diff --git a/src/luerl_anno.erl b/src/luerl_anno.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2019 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_app.erl b/src/luerl_app.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2021 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_comp.erl b/src/luerl_comp.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2019 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_comp_cg.erl b/src/luerl_comp_cg.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_comp_env.erl b/src/luerl_comp_env.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_comp_lint.erl b/src/luerl_comp_lint.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2019 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_comp_locf.erl b/src/luerl_comp_locf.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_comp_normalise.erl b/src/luerl_comp_normalise.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2019 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_comp_peep.erl b/src/luerl_comp_peep.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2019 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_comp_vars.erl b/src/luerl_comp_vars.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_emul.erl b/src/luerl_emul.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2023 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_heap.erl b/src/luerl_heap.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2020-2024 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib.erl b/src/luerl_lib.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2024 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_basic.erl b/src/luerl_lib_basic.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2024 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_bit32.erl b/src/luerl_lib_bit32.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2014-2018 Łukasz Biedrycki
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_debug.erl b/src/luerl_lib_debug.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2015-2020 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_io.erl b/src/luerl_lib_io.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2020 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_math.erl b/src/luerl_lib_math.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2020 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_os.erl b/src/luerl_lib_os.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2024 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_os_date.erl b/src/luerl_lib_os_date.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2023-2024 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_package.erl b/src/luerl_lib_package.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2020 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_string.erl b/src/luerl_lib_string.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2021 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_string_format.erl b/src/luerl_lib_string_format.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2020 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_table.erl b/src/luerl_lib_table.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2020 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_lib_utf8.erl b/src/luerl_lib_utf8.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2020 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_parse.yrl b/src/luerl_parse.yrl
@@ -1,28 +1,3 @@
-%% Copyright (c) 2013-2019 Robert Virding
-%%
-%% Licensed under the Apache License, Version 2.0 (the "License");
-%% you may not use this file except in compliance with the License.
-%% You may obtain a copy of the License at
-%%
-%%     http://www.apache.org/licenses/LICENSE-2.0
-%%
-%% Unless required by applicable law or agreed to in writing, software
-%% distributed under the License is distributed on an "AS IS" BASIS,
-%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-%% See the License for the specific language governing permissions and
-%% limitations under the License.
-
-%% File    : luerl_parse.yrl
-%% Author  : Robert Virding
-%% Purpose : Parser for LUA 5.2.
-
-%% The Grammar rules here are taken directly from the LUA 5.2
-%% manual. Unfortunately it is not an LALR(1) grammar but I have
-%% included a fix by Florian Weimer <[email protected]> which makes it
-%% so, but it needs some after processing. Actually his fix was
-%% unnecessarily complex and all that was needed was to change one
-%% rule for statements.
-
 Expect 2.					%Suppress shift/reduce warning
 
 Nonterminals
@@ -234,6 +209,36 @@ uminus -> '-' exp : {op,line('$1'),'-','$2'} .
 
 Erlang code.
 
+-moduledoc(false).
+
+%% Copyright (c) 2013-2019 Robert Virding
+%%
+%% @private
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+
+%% File    : luerl_parse.yrl
+%% Author  : Robert Virding
+%% Purpose : Parser for LUA 5.2.
+
+%% The Grammar rules here are taken directly from the LUA 5.2
+%% manual. Unfortunately it is not an LALR(1) grammar but I have
+%% included a fix by Florian Weimer <[email protected]> which makes it
+%% so, but it needs some after processing. Actually his fix was
+%% unnecessarily complex and all that was needed was to change one
+%% rule for statements.
+
+
 -export([chunk/1]).
 
 %% chunk(Tokens) -> FunctionDef | Error.

diff --git a/src/luerl_scan.xrl b/src/luerl_scan.xrl
@@ -1,21 +1,3 @@
-%% Copyright (c) 2013-2023 Robert Virding
-%%
-%% Licensed under the Apache License, Version 2.0 (the "License");
-%% you may not use this file except in compliance with the License.
-%% You may obtain a copy of the License at
-%%
-%%     http://www.apache.org/licenses/LICENSE-2.0
-%%
-%% Unless required by applicable law or agreed to in writing, software
-%% distributed under the License is distributed on an "AS IS" BASIS,
-%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-%% See the License for the specific language governing permissions and
-%% limitations under the License.
-
-%% File    : luerl_scan.xrl
-%% Author  : Robert Virding
-%% Purpose : Token definitions for LUA.
-
 Definitions.
 
 D = [0-9]
@@ -138,6 +120,29 @@ Rules.
 
 Erlang code.
 
+-moduledoc(false).
+
+%% Copyright (c) 2013-2023 Robert Virding
+%%
+%% @private
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+
+%% File    : luerl_scan.xrl
+%% Author  : Robert Virding
+%% Purpose : Token definitions for LUA.
+
+
 -export([is_keyword/1]).
 -export([string_chars/1,chars/1]).
 

diff --git a/src/luerl_sup.erl b/src/luerl_sup.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013-2021 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at

diff --git a/src/luerl_util.erl b/src/luerl_util.erl
@@ -13,7 +13,7 @@
 %% limitations under the License.
 
 %% File    : luerl_util.erl
-%% Purpose : Utility functions for Luer.
+%% Purpose : Utility functions for Luerl.
 
 -module(luerl_util).
 

diff --git a/src/ttdict.erl b/src/ttdict.erl
@@ -1,5 +1,7 @@
 %% Copyright (c) 2013 Robert Virding
 %%
+%% @private
+%%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
 %% You may obtain a copy of the License at