Updated documentation. Added external to set_user and set_host

docs/src/index.md

@@ -9,41 +9,40 @@ files in Julia.
 ```@index
 ```
 
-## Externally callable functions
 
-### Setting up global information
+## Setting up global information
 
 ```@docs
-BDIO.BDIO_set_user
-BDIO.BDIO_set_host
+BDIO_set_user
+BDIO_set_host
 ```
 
 ### Openning `BDIO` files
 
 ```@docs
-BDIO.BDIO_open
+BDIO_open
 ```
 
-### Writing data to `BDIO` files
+## Writing data to `BDIO` files
 
 ```@docs
-BDIO.BDIO_start_record!
-BDIO.BDIO_write!
-BDIO.BDIO_write_hash!
+BDIO_start_record!
+BDIO_write!
+BDIO_write_hash!
 ```
 
-### Reading data from `BDIO` files
+## Reading data from `BDIO` files
 
 ```@docs
-BDIO.BDIO_read
-BDIO.BDIO_seek!
+BDIO_read
+BDIO_seek!
 ```
 
-### Obtaining information about `BDIO` records
+## Obtaining information about `BDIO` records
 
 ```@docs
-BDIO.BDIO_get_uinfo
-BDIO.BDIO_get_len
-BDIO.BDIO_get_fmt
+BDIO_get_uinfo
+BDIO_get_len
+BDIO_get_fmt
 ```
 

src/BDIO.jl

@@ -21,6 +21,6 @@ export BDIO_BIN_GENERIC, BDIO_ASC_EXEC, BDIO_BIN_INT32BE,
 # Methods
 export BDIOstream, BDIO_open, BDIO_start_record!, BDIO_write_hash!,
     BDIO_write!, BDIO_seek!, BDIO_get_len, BDIO_get_fmt,
-    BDIO_get_uinfo, BDIO_read
+    BDIO_get_uinfo, BDIO_read, BDIO_set_user, BDIO_set_host
 
 end # module

src/BDIOmethods.jl

 """
 Set user name globally for writing BDIO files. 
 
-### Example
-BDIO_set_user("alberto")
+### Arguments
+- us: The user name
+
+### Examples
+```julia-repl
+julia> BDIO_set_user("alberto")
+```
 """
 function BDIO_set_user(us::String)
     global user = SubString(us*user, 1, 255)
@@ -12,8 +17,13 @@ end
 """
 Set host machine globally for writing BDIO files. 
 
-### Example
-BDIO_set_host("HLRN")
+### Arguments
+- us: The user name
+
+### Examples
+```julia-repl
+julia> BDIO_set_host("HLRN")
+```
 """
 function BDIO_set_host(us::String)
     global host = SubString(us*host, 1, 255)