From 8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd Mon Sep 17 00:00:00 2001 From: Alexander Pickering Date: Wed, 31 Oct 2018 12:47:37 -0400 Subject: Removed generated documentation Removed documentation, users should generate it on-the-fly if needed. This is to keep the codebase in a consistent state. If the code is changed, the documentation must be chagned too, otherwise it is possible to see the codebase with old documentation. Additionally, updaing documentation with changes to the codebase would clutter diffs. --- doc/.gitignore | 1 + doc/index.html | 423 ---------------------------------------------- doc/ldoc.css | 303 --------------------------------- doc/net/create_socket.md | 0 doc/topics/readme.md.html | 81 --------- 5 files changed, 1 insertion(+), 807 deletions(-) create mode 100644 doc/.gitignore delete mode 100644 doc/index.html delete mode 100644 doc/ldoc.css delete mode 100644 doc/net/create_socket.md delete mode 100644 doc/topics/readme.md.html (limited to 'doc') diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..8d98f9d --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +.* diff --git a/doc/index.html b/doc/index.html deleted file mode 100644 index 517b2c9..0000000 --- a/doc/index.html +++ /dev/null @@ -1,423 +0,0 @@ - - - - - Reference - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module net

-

The net library -Exposes various structs, constants, and functions for passing messages

-

- - -

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
stream:readint ()Read an integer from the stream
stream:readdouble ()Read double percision float from the stream
stream:readdata (size)Read some data from the stream
stream:readstring ()Read a string from the stream
stream:writeint (i)Write an integer to the stream
stream:writedouble (d)Write a double percision float to the stream
stream:writedata (d)Write some data to the stream
stream:writestring (s)Write a string to the stream
socket:bind (where)
receive (message, callback)
newsocket ()
-

Tables

- - - - - -
socket
- -
-
- - -

Functions

- -
-
- - stream:readint () -
-
- Read an integer from the stream - - - - -

Returns:

-
    - - number - The number read from the stream -
- - - - -
-
- - stream:readdouble () -
-
- Read double percision float from the stream - - - - -

Returns:

-
    - - number - The number read from the stream -
- - - - -
-
- - stream:readdata (size) -
-
- Read some data from the stream - - - -

Parameters:

-
    -
  • size - number - The size of the data to read from the stream -
    • -
- -

Returns:

-
    - - string - The data read from the stream -
- - - - -
-
- - stream:readstring () -
-
- Read a string from the stream - - - - -

Returns:

-
    - - string - The string read from the stream -
- - - - -
-
- - stream:writeint (i) -
-
- Write an integer to the stream - - - -

Parameters:

-
    -
  • i - number - The integer to write to the stream -
    • -
- - - - - -
-
- - stream:writedouble (d) -
-
- Write a double percision float to the stream - - - -

Parameters:

-
    -
  • d - number - The number to write to the stream -
    • -
- - - - - -
-
- - stream:writedata (d) -
-
- Write some data to the stream - - - -

Parameters:

-
    -
  • d - number - The number to write to the stream -
    • -
- -

Returns:

-
    - - number - The number of bytes written to the stream -
- - - - -
-
- - stream:writestring (s) -
-
- Write a string to the stream - - - -

Parameters:

-
    -
  • s - string - The string to the stream -
    • -
- - - - - -
-
- - socket:bind (where) -
-
- - - - -

Parameters:

-
    -
  • where - string - Where to connect this socket to -
    • -
- - - - -

Usage:

-
    - 
    local s = net.newsocket()
-s:bind("127.0.0.1")
-s:receive("ping",function(stream)
-	print(instream:readstring())
-end)
-local c = net.newsocket()
-c:connect("127.0.0.1")
    -
- -
-
- - receive (message, callback) -
-
- - - - -

Parameters:

-
    -
  • message - string - The message to bind this function to -
    • -
  • callback - function - The function to call when this message is received -
    • -
- - - - - -
-
- - newsocket () -
-
- - -

domain:

-
    - shared -
- - -

Returns:

-
    - - net.socket -
- - - - -
-
-

Tables

- -
-
- - socket -
-
- - -

domain:

-
    - shared -
- -

Fields:

-
    -
  • fd - -
    • -
- - - - - -
-
- - -
-
-
-generated by LDoc 1.4.6 -Last updated 2018-07-03 16:38:22 -
-
- - diff --git a/doc/ldoc.css b/doc/ldoc.css deleted file mode 100644 index 52c4ad2..0000000 --- a/doc/ldoc.css +++ /dev/null @@ -1,303 +0,0 @@ -/* BEGIN RESET - -Copyright (c) 2010, Yahoo! Inc. All rights reserved. -Code licensed under the BSD License: -http://developer.yahoo.com/yui/license.html -version: 2.8.2r1 -*/ -html { - color: #000; - background: #FFF; -} -body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { - margin: 0; - padding: 0; -} -table { - border-collapse: collapse; - border-spacing: 0; -} -fieldset,img { - border: 0; -} -address,caption,cite,code,dfn,em,strong,th,var,optgroup { - font-style: inherit; - font-weight: inherit; -} -del,ins { - text-decoration: none; -} -li { - margin-left: 20px; -} -caption,th { - text-align: left; -} -h1,h2,h3,h4,h5,h6 { - font-size: 100%; - font-weight: bold; -} -q:before,q:after { - content: ''; -} -abbr,acronym { - border: 0; - font-variant: normal; -} -sup { - vertical-align: baseline; -} -sub { - vertical-align: baseline; -} -legend { - color: #000; -} -input,button,textarea,select,optgroup,option { - font-family: inherit; - font-size: inherit; - font-style: inherit; - font-weight: inherit; -} -input,button,textarea,select {*font-size:100%; -} -/* END RESET */ - -body { - margin-left: 1em; - margin-right: 1em; - font-family: arial, helvetica, geneva, sans-serif; - background-color: #ffffff; margin: 0px; -} - -code, tt { font-family: monospace; font-size: 1.1em; } -span.parameter { font-family:monospace; } -span.parameter:after { content:":"; } -span.types:before { content:"("; } -span.types:after { content:")"; } -.type { font-weight: bold; font-style:italic } - -body, p, td, th { font-size: .95em; line-height: 1.2em;} - -p, ul { margin: 10px 0 0 0px;} - -strong { font-weight: bold;} - -em { font-style: italic;} - -h1 { - font-size: 1.5em; - margin: 20px 0 20px 0; -} -h2, h3, h4 { margin: 15px 0 10px 0; } -h2 { font-size: 1.25em; } -h3 { font-size: 1.15em; } -h4 { font-size: 1.06em; } - -a:link { font-weight: bold; color: #004080; text-decoration: none; } -a:visited { font-weight: bold; color: #006699; text-decoration: none; } -a:link:hover { text-decoration: underline; } - -hr { - color:#cccccc; - background: #00007f; - height: 1px; -} - -blockquote { margin-left: 3em; } - -ul { list-style-type: disc; } - -p.name { - font-family: "Andale Mono", monospace; - padding-top: 1em; -} - -pre { - background-color: rgb(245, 245, 245); - border: 1px solid #C0C0C0; /* silver */ - padding: 10px; - margin: 10px 0 10px 0; - overflow: auto; - font-family: "Andale Mono", monospace; -} - -pre.example { - font-size: .85em; -} - -table.index { border: 1px #00007f; } -table.index td { text-align: left; vertical-align: top; } - -#container { - margin-left: 1em; - margin-right: 1em; - background-color: #f0f0f0; -} - -#product { - text-align: center; - border-bottom: 1px solid #cccccc; - background-color: #ffffff; -} - -#product big { - font-size: 2em; -} - -#main { - background-color: #f0f0f0; - border-left: 2px solid #cccccc; -} - -#navigation { - float: left; - width: 14em; - vertical-align: top; - background-color: #f0f0f0; - overflow: visible; -} - -#navigation h2 { - background-color:#e7e7e7; - font-size:1.1em; - color:#000000; - text-align: left; - padding:0.2em; - border-top:1px solid #dddddd; - border-bottom:1px solid #dddddd; -} - -#navigation ul -{ - font-size:1em; - list-style-type: none; - margin: 1px 1px 10px 1px; -} - -#navigation li { - text-indent: -1em; - display: block; - margin: 3px 0px 0px 22px; -} - -#navigation li li a { - margin: 0px 3px 0px -1em; -} - -#content { - margin-left: 14em; - padding: 1em; - width: 700px; - border-left: 2px solid #cccccc; - border-right: 2px solid #cccccc; - background-color: #ffffff; -} - -#about { - clear: both; - padding: 5px; - border-top: 2px solid #cccccc; - background-color: #ffffff; -} - -@media print { - body { - font: 12pt "Times New Roman", "TimeNR", Times, serif; - } - a { font-weight: bold; color: #004080; text-decoration: underline; } - - #main { - background-color: #ffffff; - border-left: 0px; - } - - #container { - margin-left: 2%; - margin-right: 2%; - background-color: #ffffff; - } - - #content { - padding: 1em; - background-color: #ffffff; - } - - #navigation { - display: none; - } - pre.example { - font-family: "Andale Mono", monospace; - font-size: 10pt; - page-break-inside: avoid; - } -} - -table.module_list { - border-width: 1px; - border-style: solid; - border-color: #cccccc; - border-collapse: collapse; -} -table.module_list td { - border-width: 1px; - padding: 3px; - border-style: solid; - border-color: #cccccc; -} -table.module_list td.name { background-color: #f0f0f0; min-width: 200px; } -table.module_list td.summary { width: 100%; } - - -table.function_list { - border-width: 1px; - border-style: solid; - border-color: #cccccc; - border-collapse: collapse; -} -table.function_list td { - border-width: 1px; - padding: 3px; - border-style: solid; - border-color: #cccccc; -} -table.function_list td.name { background-color: #f0f0f0; min-width: 200px; } -table.function_list td.summary { width: 100%; } - -ul.nowrap { - overflow:auto; - white-space:nowrap; -} - -dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} -dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} -dl.table h3, dl.function h3 {font-size: .95em;} - -/* stop sublists from having initial vertical space */ -ul ul { margin-top: 0px; } -ol ul { margin-top: 0px; } -ol ol { margin-top: 0px; } -ul ol { margin-top: 0px; } - -/* make the target distinct; helps when we're navigating to a function */ -a:target + * { - background-color: #FF9; -} - - -/* styles for prettification of source */ -pre .comment { color: #558817; } -pre .constant { color: #a8660d; } -pre .escape { color: #844631; } -pre .keyword { color: #aa5050; font-weight: bold; } -pre .library { color: #0e7c6b; } -pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } -pre .string { color: #8080ff; } -pre .number { color: #f8660d; } -pre .operator { color: #2239a8; font-weight: bold; } -pre .preprocessor, pre .prepro { color: #a33243; } -pre .global { color: #800080; } -pre .user-keyword { color: #800080; } -pre .prompt { color: #558817; } -pre .url { color: #272fc2; text-decoration: underline; } - diff --git a/doc/net/create_socket.md b/doc/net/create_socket.md deleted file mode 100644 index e69de29..0000000 diff --git a/doc/topics/readme.md.html b/doc/topics/readme.md.html deleted file mode 100644 index f250100..0000000 --- a/doc/topics/readme.md.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Reference - - - - -
- -
- -
-
-
- - -
- - - - - - -
- - # Brok[en]gine -

![logo](https://cogarr.net/files/alex/brokenengine_small.png) -

Broken Engine is a hobby game engine that glues [Bullet Physics](bulletphysics.org/wordpress), [Irrlicht](irrlicht.sourceforge.net), [Lua](www.lua.org), and [various](nanomsg.org) [other](www.boost.org) technologies togeather to give a realtime, 3d, physics engine. -

## Download -

Binaries will not be provided until Brok[en]gine reaches version 1.0, if you want to try it out before then, you will have to build the engine yourself. -

1. Use [git](git-scm.com) to download this with submodules `git clone --recurse-submodules https://cogarr.net/source/cgi.cgit/brokengine` -2. Download make, g++, ect. Windows users can use [mingw](https://mingw.org). Open a terminal and cd into this folder, and run `make` -3. Binaries can be found in bin/(client|server)/bin/ -4. Initally ran scripts can be found at bin/(client|server)/data/init.lua -

## Documentation -Currently, documentation does not exist... I'll get around to it before 1.0 -

## Misc. -This project is under very heavy development. Expect lots of code churn for the foreseeable future. -

### Roadmap -0. Lua-defined textures -1. Lua-defined materials -2. Lua-defined models -3. Lua-defined hitboxes -4. Networking utilities -5. Make a tech demo game - - -

-
-
-generated by LDoc 1.4.6 -Last updated 2018-07-03 16:38:22 -
-
- - -- cgit v1.2.3-70-g09d2