Added shell and licensing

1 files changed, 30 insertions, 0 deletions

diff --git a/builtins.h b/builtins.h
index 7570eab..6a9b012 100644
--- a/builtins.h
+++ b/builtins.h
@@ -1,3 +1,24 @@
+/**
+ * @file builtins.h
+ * Provides built-in functions for the interpreter
+ * These must be loaded for an instance to do anything meaningful.
+ *
+ * Copyright (C) 2018 Clyne Sullivan
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
 #ifndef BUILTINS_H_
 #define BUILTINS_H_
 
@@ -6,8 +27,17 @@
 #define SKIP_SIG (uint32_t)-5
 #define CALL_SIG (uint32_t)-6
 
+/**
+ * Loads the built-in functions into the given instance.
+ * @param it the instance to use
+ */
 void iload_builtins(instance *it);
 
+/**
+ * The built-in 'end' function, called at closed scopes (i.e. '}').
+ * Exposed for the parser so that closing brackets can be tied to this call.
+ * @param it the current instance
+ */
 int bn_end(instance *it);
 
 #endif // BUILTINS_H_