diff options
46 files changed, 1 insertions, 47 deletions
diff --git a/coding_standard/coding_standard.tex b/coding_standard/coding_standard.tex index 4d663a1..469c523 100644 --- a/coding_standard/coding_standard.tex +++ b/coding_standard/coding_standard.tex @@ -55,11 +55,10 @@ Implementation files will NEVER be included by another file. Files with the ext \section{Comments} We only add comments for public members and methods. Comments for protected/private members and methods are not required. \subsection{File comments} -At the top of every file that has not been automatically generated, a comment block containing the file name, author name, brief description in the following form (Doxygen style commenting) after the licence comment block: +At the top of every file that has not been automatically generated, a comment block containing the file name, brief description in the following form (Doxygen style commenting) after the licence comment block: \begin{verbatim} /// /// \file: filename.h -/// \author: author name /// \brief description of the file /// \end{verbatim} diff --git a/src/builtins/builtin_exceptions.h b/src/builtins/builtin_exceptions.h index a5cc28b..d6eded4 100644 --- a/src/builtins/builtin_exceptions.h +++ b/src/builtins/builtin_exceptions.h @@ -18,7 +18,6 @@ */ /// /// \file builtin_exceptions.h -/// \author Mu Qiao /// \brief implementations for builtin exceptions /// diff --git a/src/builtins/continue_builtin.cpp b/src/builtins/continue_builtin.cpp index 87dd59a..07c269a 100644 --- a/src/builtins/continue_builtin.cpp +++ b/src/builtins/continue_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file continue_builtin.h -/// \author Mu Qiao /// \brief implementation for the continue builtin /// #include <boost/lexical_cast.hpp> diff --git a/src/builtins/declare_builtin.cpp b/src/builtins/declare_builtin.cpp index 90b127f..2a1d300 100644 --- a/src/builtins/declare_builtin.cpp +++ b/src/builtins/declare_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file declare_builtin.cpp -/// \author Mu Qiao /// \brief class that implements the declare builtin /// #include <algorithm> diff --git a/src/builtins/declare_builtin.h b/src/builtins/declare_builtin.h index 8a3b1ed..971933a 100644 --- a/src/builtins/declare_builtin.h +++ b/src/builtins/declare_builtin.h @@ -18,7 +18,6 @@ */ /// /// \file declare_builtin.h -/// \author Mu Qiao /// \brief class that implements the declare builtin /// diff --git a/src/builtins/echo_builtin.cpp b/src/builtins/echo_builtin.cpp index 0e21707..8d703ff 100644 --- a/src/builtins/echo_builtin.cpp +++ b/src/builtins/echo_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file echo_builtin.cpp -/// \author Nathan Eloe /// \brief class that implements the echo builtin /// diff --git a/src/builtins/echo_builtin.h b/src/builtins/echo_builtin.h index df9d015..6de6475 100644 --- a/src/builtins/echo_builtin.h +++ b/src/builtins/echo_builtin.h @@ -18,7 +18,6 @@ */ /// /// \file echo_builtin.h -/// \author Nathan Eloe /// \brief class that implements the echo builtin /// diff --git a/src/builtins/eval_builtin.cpp b/src/builtins/eval_builtin.cpp index 5e5a61b..cf5d8fd 100644 --- a/src/builtins/eval_builtin.cpp +++ b/src/builtins/eval_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file eval_builtin.h -/// \author Mu Qiao /// \brief class that implements the eval builtin /// diff --git a/src/builtins/eval_builtin.h b/src/builtins/eval_builtin.h index 87746e9..ea2222c 100644 --- a/src/builtins/eval_builtin.h +++ b/src/builtins/eval_builtin.h @@ -18,7 +18,6 @@ */ /// /// \file eval_builtin.h -/// \author Mu Qiao /// \brief class that implements the eval builtin /// diff --git a/src/builtins/inherit_builtin.cpp b/src/builtins/inherit_builtin.cpp index 4793d5c..e7597df 100644 --- a/src/builtins/inherit_builtin.cpp +++ b/src/builtins/inherit_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file inherit_builtin.cpp -/// \author Mu Qiao /// \brief class that implements the inherit builtin /// diff --git a/src/builtins/inherit_builtin.h b/src/builtins/inherit_builtin.h index 6a2dc49..0e7f6ef 100644 --- a/src/builtins/inherit_builtin.h +++ b/src/builtins/inherit_builtin.h @@ -18,7 +18,6 @@ */ /// /// \file inherit_builtin.h -/// \author Mu Qiao /// \brief class that implements the inherit function from Portage /// diff --git a/src/builtins/let_builtin.cpp b/src/builtins/let_builtin.cpp index 43f28a3..04eb857 100644 --- a/src/builtins/let_builtin.cpp +++ b/src/builtins/let_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file let_builtin.h -/// \author Mu Qiao /// \brief implementation for the let builtin /// #include <sstream> diff --git a/src/builtins/return_builtin.cpp b/src/builtins/return_builtin.cpp index 3180345..161e530 100644 --- a/src/builtins/return_builtin.cpp +++ b/src/builtins/return_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file return_builtin.h -/// \author Mu Qiao /// \brief implementation for the return builtin /// diff --git a/src/builtins/shopt_builtin.cpp b/src/builtins/shopt_builtin.cpp index 9d60d74..b3b8aac 100644 --- a/src/builtins/shopt_builtin.cpp +++ b/src/builtins/shopt_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file shopt_builtin.cpp -/// \author Mu Qiao /// \brief implementation for the shopt builtin /// diff --git a/src/builtins/source_builtin.cpp b/src/builtins/source_builtin.cpp index 5f78177..4103576 100644 --- a/src/builtins/source_builtin.cpp +++ b/src/builtins/source_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file source_builtin.h -/// \author Mu Qiao /// \brief class that implements the source builtin /// diff --git a/src/builtins/source_builtin.h b/src/builtins/source_builtin.h index 964d214..d599824 100644 --- a/src/builtins/source_builtin.h +++ b/src/builtins/source_builtin.h @@ -18,7 +18,6 @@ */ /// /// \file source_builtin.h -/// \author Mu Qiao /// \brief class that implements the source builtin /// diff --git a/src/builtins/tests/declare_tests.cpp b/src/builtins/tests/declare_tests.cpp index 4697aed..95c0949 100644 --- a/src/builtins/tests/declare_tests.cpp +++ b/src/builtins/tests/declare_tests.cpp @@ -19,7 +19,6 @@ /// /// \file declare_tests.cpp /// \brief series of unit tests for declare built in -/// \author Mu Qiao Eloe /// #include <iostream> #include <sstream> diff --git a/src/builtins/tests/echo_tests.cpp b/src/builtins/tests/echo_tests.cpp index bee9be5..7b38422 100644 --- a/src/builtins/tests/echo_tests.cpp +++ b/src/builtins/tests/echo_tests.cpp @@ -19,7 +19,6 @@ /// /// \file echo_tests.cpp /// \brief series of unit tests for echo built in -/// \author Nathan Eloe /// #include <iostream> #include <sstream> diff --git a/src/builtins/unset_builtin.cpp b/src/builtins/unset_builtin.cpp index 1490013..8266e9e 100644 --- a/src/builtins/unset_builtin.cpp +++ b/src/builtins/unset_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file unset_builtin.h -/// \author Mu Qiao /// \brief implementation for the unset builtin /// #include <functional> diff --git a/src/common.h b/src/common.h index ffc6492..537e8d8 100644 --- a/src/common.h +++ b/src/common.h @@ -18,7 +18,6 @@ */ /// /// \file common.h -/// \author Mu Qiao /// \brief common macros and includes /// diff --git a/src/core/bash_ast.cpp b/src/core/bash_ast.cpp index 8c23850..8033022 100644 --- a/src/core/bash_ast.cpp +++ b/src/core/bash_ast.cpp @@ -18,7 +18,6 @@ */ /// /// \file bash_ast.cpp -/// \author Mu Qiao /// \brief a wrapper class that helps interpret from istream and string /// #include <fstream> diff --git a/src/core/bash_ast.h b/src/core/bash_ast.h index 5469d95..077a46a 100644 --- a/src/core/bash_ast.h +++ b/src/core/bash_ast.h @@ -18,7 +18,6 @@ */ /// /// \file bash_ast.h -/// \author Mu Qiao /// \brief a class that helps interpret from istream and string /// diff --git a/src/core/bash_condition.cpp b/src/core/bash_condition.cpp index 48b523e..9c3127f 100644 --- a/src/core/bash_condition.cpp +++ b/src/core/bash_condition.cpp @@ -18,7 +18,6 @@ */ /// /// \file bash_condition.cpp -/// \author Mu Qiao /// \brief implementation for Bash Conditional Expressions /// #include <ctime> diff --git a/src/core/bash_condition.h b/src/core/bash_condition.h index 8723c28..a47a460 100644 --- a/src/core/bash_condition.h +++ b/src/core/bash_condition.h @@ -18,7 +18,6 @@ */ /// /// \file bash_condition.h -/// \author Mu Qiao /// \brief implementation for Bash Conditional Expressions /// #ifndef LIBBASH_CORE_BASH_CONDITION_H_ diff --git a/src/core/interpreter.cpp b/src/core/interpreter.cpp index fc12a7a..0518860 100644 --- a/src/core/interpreter.cpp +++ b/src/core/interpreter.cpp @@ -18,7 +18,6 @@ */ /// /// \file interpreter.cpp -/// \author Mu Qiao /// \brief implementations for bash interpreter (visitor pattern). /// diff --git a/src/core/interpreter.h b/src/core/interpreter.h index 46c3d6a..d564279 100644 --- a/src/core/interpreter.h +++ b/src/core/interpreter.h @@ -18,7 +18,6 @@ */ /// /// \file interpreter.h -/// \author Mu Qiao /// \brief implementation for bash interpreter (visitor pattern) /// diff --git a/src/core/interpreter_exception.h b/src/core/interpreter_exception.h index ae795dc..bc66a96 100644 --- a/src/core/interpreter_exception.h +++ b/src/core/interpreter_exception.h @@ -18,7 +18,6 @@ */ /// /// \file interpreter_exception.h -/// \author Mu Qiao /// \brief implementation for interpreter_exception /// diff --git a/src/core/symbols.hpp b/src/core/symbols.hpp index 8ceb25a..9ecff43 100644 --- a/src/core/symbols.hpp +++ b/src/core/symbols.hpp @@ -18,7 +18,6 @@ */ /// /// \file symbols.hpp -/// \author Mu Qiao /// \brief template implementation for symbols and symbol table /// diff --git a/src/core/tests/bash_ast_test.cpp b/src/core/tests/bash_ast_test.cpp index b2376fb..d335d80 100644 --- a/src/core/tests/bash_ast_test.cpp +++ b/src/core/tests/bash_ast_test.cpp @@ -18,7 +18,6 @@ */ /// /// \file bash_ast_test.cpp -/// \author Mu Qiao /// \brief series of unit tests for interpreter. /// diff --git a/src/core/tests/bash_condition_test.cpp b/src/core/tests/bash_condition_test.cpp index de56fee..58e9ce7 100644 --- a/src/core/tests/bash_condition_test.cpp +++ b/src/core/tests/bash_condition_test.cpp @@ -18,7 +18,6 @@ */ /// /// \file bash_condition_test.cpp -/// \author Mu Qiao /// \brief series of unit tests for interpreter. /// #include <fcntl.h> diff --git a/src/core/tests/interpreter_test.cpp b/src/core/tests/interpreter_test.cpp index 6a39591..b023533 100644 --- a/src/core/tests/interpreter_test.cpp +++ b/src/core/tests/interpreter_test.cpp @@ -18,7 +18,6 @@ */ /// /// \file interpreter_test.cpp -/// \author Mu Qiao /// \brief series of unit tests for interpreter. /// diff --git a/src/core/tests/symbols_test.cpp b/src/core/tests/symbols_test.cpp index 358f5b6..cf24cf0 100644 --- a/src/core/tests/symbols_test.cpp +++ b/src/core/tests/symbols_test.cpp @@ -18,7 +18,6 @@ */ /// /// \file symbols_test.cpp -/// \author Mu Qiao /// \brief series of unit tests for symbols and symbol table. /// diff --git a/src/core/unset_exception.h b/src/core/unset_exception.h index 7ee6c03..7924512 100644 --- a/src/core/unset_exception.h +++ b/src/core/unset_exception.h @@ -18,7 +18,6 @@ */ /// /// \file unset_exception.h -/// \author Mu Qiao /// \brief implementation for unset_exception /// diff --git a/src/cppbash_builtin.cpp b/src/cppbash_builtin.cpp index a66622e..a0299a9 100644 --- a/src/cppbash_builtin.cpp +++ b/src/cppbash_builtin.cpp @@ -18,7 +18,6 @@ */ /// /// \file cppbash_builtin.cpp -/// \author Nathan Eloe /// \brief Implementation of class to inherit builtins from /// diff --git a/src/cppbash_builtin.h b/src/cppbash_builtin.h index 11c1edb..96d80a0 100644 --- a/src/cppbash_builtin.h +++ b/src/cppbash_builtin.h @@ -18,7 +18,6 @@ */ /// /// \file cppbash_builtin.h -/// \author Nathan Eloe /// \brief Base class for builtin functions in bash /// diff --git a/src/libbash.cpp b/src/libbash.cpp index bc94433..27ca38d 100644 --- a/src/libbash.cpp +++ b/src/libbash.cpp @@ -18,7 +18,6 @@ */ /// /// \file libbash.cpp -/// \author Mu Qiao /// \brief implementation for libbash interface /// diff --git a/src/libbash.h b/src/libbash.h index 05c5758..ab3a630 100644 --- a/src/libbash.h +++ b/src/libbash.h @@ -18,7 +18,6 @@ */ /// /// \file libbash.h -/// \author Mu Qiao /// \brief public interface for libbash /// diff --git a/test/api_test.cpp b/test/api_test.cpp index a724401..7744ebf 100644 --- a/test/api_test.cpp +++ b/test/api_test.cpp @@ -18,7 +18,6 @@ */ /// /// \file api_test.cpp -/// \author Mu Qiao /// \brief series of unit tests for the public interface /// diff --git a/test/post_check.cpp b/test/post_check.cpp index f7feebd..2a411f8 100644 --- a/test/post_check.cpp +++ b/test/post_check.cpp @@ -18,7 +18,6 @@ */ /// /// \file post_check.cpp -/// \author Mu Qiao /// \brief series of unit tests for generated source files. /// diff --git a/test/test.cpp b/test/test.cpp index da4bc9e..e460fc1 100644 --- a/test/test.cpp +++ b/test/test.cpp @@ -18,7 +18,6 @@ */ /// /// \file test.cpp -/// \author Mu Qiao /// \brief helper functions for tests /// #include <cstdlib> diff --git a/test/test.h b/test/test.h index 18a1a31..ba5cd1f 100644 --- a/test/test.h +++ b/test/test.h @@ -18,7 +18,6 @@ */ /// /// \file test.h -/// \author Mu Qiao /// \brief helper functions for tests /// #ifndef LIBBASH_TEST_H_ diff --git a/test/walker_test.cpp b/test/walker_test.cpp index 41a4fc4..bfdba83 100644 --- a/test/walker_test.cpp +++ b/test/walker_test.cpp @@ -18,7 +18,6 @@ */ /// /// \file lib_test.cpp -/// \author Mu Qiao /// \brief series of unit tests for generated walker. /// diff --git a/utils/metadata.cpp b/utils/metadata.cpp index 899ef80..e200ab3 100644 --- a/utils/metadata.cpp +++ b/utils/metadata.cpp @@ -18,7 +18,6 @@ */ /// /// \file metadata.cpp -/// \author Mu Qiao /// \brief a helper for printing metadata content /// #include <set> diff --git a/utils/metadata.h b/utils/metadata.h index cb7f559..7071ce0 100644 --- a/utils/metadata.h +++ b/utils/metadata.h @@ -18,7 +18,6 @@ */ /// /// \file metadata.h -/// \author Mu Qiao /// \brief a helper for printing metadata content /// #include <iostream> diff --git a/utils/metadata_generator.cpp b/utils/metadata_generator.cpp index 14602f2..8951044 100644 --- a/utils/metadata_generator.cpp +++ b/utils/metadata_generator.cpp @@ -18,7 +18,6 @@ */ /// /// \file metadata_generator.cpp -/// \author Mu Qiao /// \brief a simple utility for generating metadata /// #include <iostream> diff --git a/utils/variable_printer.cpp b/utils/variable_printer.cpp index 4a66d70..001e75e 100644 --- a/utils/variable_printer.cpp +++ b/utils/variable_printer.cpp @@ -18,7 +18,6 @@ */ /// /// \file variable_printer.cpp -/// \author Mu Qiao /// \brief a program to write variables in a script into standard output /// |