-
Notifications
You must be signed in to change notification settings - Fork 3
/
bashdoc
executable file
·54 lines (45 loc) · 2.31 KB
/
bashdoc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
#!/usr/bin/env bash
cat << BASHDocMsg
As of right now bashdoc is really just a personal convention. It is something that I intend to implement in tandem to blp. That is why you will see my files are all documented using this non existent standard.
I have used a few other DOC systems and intend to make bashdoc a bit more functional. This is why I have included things like the intall tags that enable you to specify the proper installation of an element.
It is evolving and depending on how much help I get with the project will determine how much I can conceivably accomplish. I will add a more formalized definition of the tags so as time permits.
I will also include a bashdoc.blp in the distribution that will hopefully address some of these action items. In any event I haven't exactly sussed this all out yet.
############
# std.blp - A bash library of common functions to increase reusability of code
#
#
# @install /usr/local/lib/blp
# installation- It is recommended that this file be placed in /usr/local/lib/blp and sourced
# into your code via the . /usr/local/lib/blp/std.blp method
#
# Conventions:
# Funciton names start with lower case followed by camel text
# Variables start with upper case followed by camel text
#
# @author Mikel King <mikel.king@olivent.com>
# @descr Basically all this file does is setup the standard include/require hiearchy.
# If you have defined these values then these functions will respect these definitions
# if they are set prior to calling this file. Obviously if you set them after you call
# this file then it really doesn't matter.
# @copyright 2012 Olivent Technologies, llc
# @package std.blp
# @version 2.0
# @license http://opensource.org/licenses/bsd-license.php New/Simplified BSD License
# @todo draft a bashdoc.txt file that explains the @tags
############
# @pkg logging
# @pkgdescr logging support library for the (disk, mem, & sys) check applications
# @version 2.0
#
# Using the following param will tell INSTALL where this file should be installed.
# Of course I haven't written INSTALL yet so that wont happen...;-P
#
# @install /usr/local/lib/
# installation-
#
# @author Mikel King <mikel.king@olivent.com>
# @copyright 2012 Olivent Technologies, llc
# @dependency blp
# @license http://opensource.org/licenses/bsd-license.php New/Simplified BSD License
# @todo
BASHDocMsg