docs: Cleanup file headers and comments. (#58)

3 files changed, 46 insertions, 3 deletions

diff --git a/utils/bcmregtool/apeloader/CMakeLists.txt b/utils/bcmregtool/apeloader/CMakeLists.txt
index 1f8ce69..629fb6e 100644
--- a/utils/bcmregtool/apeloader/CMakeLists.txt
+++ b/utils/bcmregtool/apeloader/CMakeLists.txt
@@ -4,7 +4,7 @@
 ###
 ### @project    bcm5719
 ###
-### @brief      First binary stage for the bcm5719
+### @brief      APE loader utlity firmware for the bcm5719
 ###
 ################################################################################
 ###
diff --git a/utils/bcmregtool/apeloader/ape.ld b/utils/bcmregtool/apeloader/ape.ld
index 3b26fae..77636be 100644
--- a/utils/bcmregtool/apeloader/ape.ld
+++ b/utils/bcmregtool/apeloader/ape.ld
@@ -1,4 +1,47 @@
-OUTPUT_FORMAT(binary)
+################################################################################
+###
+### @file       ape.ld
+###
+### @project    bcm5719
+###
+### @brief      APE linker script
+###
+################################################################################
+###
+################################################################################
+###
+### @copyright Copyright (c) 2018-2020, Evan Lojewski
+### @cond
+###
+### All rights reserved.
+###
+### Redistribution and use in source and binary forms, with or without
+### modification, are permitted provided that the following conditions are met:
+### 1. Redistributions of source code must retain the above copyright notice,
+### this list of conditions and the following disclaimer.
+### 2. Redistributions in binary form must reproduce the above copyright notice,
+### this list of conditions and the following disclaimer in the documentation
+### and/or other materials provided with the distribution.
+### 3. Neither the name of the copyright holder nor the
+### names of its contributors may be used to endorse or promote products
+### derived from this software without specific prior written permission.
+###
+################################################################################
+###
+### THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+### AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+### IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+### ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+### LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+### CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+### SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+### INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+### CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+### ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+### POSSIBILITY OF SUCH DAMAGE.
+### @endcond
+################################################################################
+
 ENTRY(__start)
 
 SECTIONS
diff --git a/utils/bcmregtool/apeloader/main.c b/utils/bcmregtool/apeloader/main.c
index 54c4642..0fa12ca 100644
--- a/utils/bcmregtool/apeloader/main.c
+++ b/utils/bcmregtool/apeloader/main.c
@@ -4,7 +4,7 @@
 ///
 /// @project
 ///
-/// @brief      Main stage1 code
+/// @brief      Main apeloader code
 ///
 ////////////////////////////////////////////////////////////////////////////////
 ///