From 7764a6a14da1b0c8da0d58276ee0914583adf84c Mon Sep 17 00:00:00 2001
From: Houtan Bastani <houtan.bastani@ens.fr>
Date: Tue, 11 Oct 2011 16:35:13 +0200
Subject: [PATCH] MS-SBVAR: normalize comments in headers

---
 matlab/ms-sbvar/clean_files_for_second_type_of_mex.m    | 2 +-
 matlab/ms-sbvar/clean_ms_estimation_files.m             | 2 +-
 matlab/ms-sbvar/clean_ms_forecast_files.m               | 2 +-
 matlab/ms-sbvar/clean_ms_init_files.m                   | 2 +-
 matlab/ms-sbvar/clean_ms_irf_files.m                    | 2 +-
 matlab/ms-sbvar/clean_ms_mdd_files.m                    | 2 +-
 matlab/ms-sbvar/clean_ms_probabilities_files.m          | 2 +-
 matlab/ms-sbvar/clean_ms_simulation_files.m             | 2 +-
 matlab/ms-sbvar/clean_ms_variance_decomposition_files.m | 2 +-
 matlab/ms-sbvar/clean_sbvar_files.m                     | 2 +-
 matlab/ms-sbvar/create_dir.m                            | 2 +-
 matlab/ms-sbvar/delete_dir_if_exists.m                  | 2 +-
 matlab/ms-sbvar/delete_if_exists.m                      | 2 +-
 matlab/ms-sbvar/dyn_save_graph.m                        | 2 +-
 matlab/ms-sbvar/initialize_ms_sbvar_options.m           | 2 +-
 matlab/ms-sbvar/ms_compute_mdd.m                        | 4 ++--
 matlab/ms-sbvar/ms_compute_probabilities.m              | 4 ++--
 matlab/ms-sbvar/ms_estimation.m                         | 4 ++--
 matlab/ms-sbvar/ms_forecast.m                           | 4 ++--
 matlab/ms-sbvar/ms_irf.m                                | 6 +++---
 matlab/ms-sbvar/ms_sbvar_setup.m                        | 2 +-
 matlab/ms-sbvar/ms_simulation.m                         | 4 ++--
 matlab/ms-sbvar/ms_variance_decomposition.m             | 4 ++--
 matlab/ms-sbvar/plot_ms_forecast.m                      | 2 +-
 matlab/ms-sbvar/plot_ms_irf.m                           | 2 +-
 matlab/ms-sbvar/plot_ms_probabilities.m                 | 2 +-
 matlab/ms-sbvar/plot_ms_variance_decomposition.m        | 4 ++--
 matlab/ms-sbvar/set_file_tags.m                         | 2 +-
 matlab/ms-sbvar/set_ms_estimation_file.m                | 2 +-
 matlab/ms-sbvar/set_ms_simulation_file.m                | 2 +-
 30 files changed, 39 insertions(+), 39 deletions(-)

diff --git a/matlab/ms-sbvar/clean_files_for_second_type_of_mex.m b/matlab/ms-sbvar/clean_files_for_second_type_of_mex.m
index fe18ecee0..d29b532bf 100644
--- a/matlab/ms-sbvar/clean_files_for_second_type_of_mex.m
+++ b/matlab/ms-sbvar/clean_files_for_second_type_of_mex.m
@@ -1,5 +1,5 @@
 function clean_files_for_second_type_of_mex(M_, options_, type)
-%function clean_files_for_second_type_of_mex()
+% function clean_files_for_second_type_of_mex(M_, options_, type)
 % clean the files for the appropriate file tag and mex function
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/clean_ms_estimation_files.m b/matlab/ms-sbvar/clean_ms_estimation_files.m
index 927673987..aaf2e01a8 100644
--- a/matlab/ms-sbvar/clean_ms_estimation_files.m
+++ b/matlab/ms-sbvar/clean_ms_estimation_files.m
@@ -1,5 +1,5 @@
 function clean_ms_estimation_files(file_tag)
-% function clean_ms_estimation_files()
+% function clean_ms_estimation_files(file_tag)
 % removes MS estimation files
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/clean_ms_forecast_files.m b/matlab/ms-sbvar/clean_ms_forecast_files.m
index f03b9d6ab..a7b27741f 100644
--- a/matlab/ms-sbvar/clean_ms_forecast_files.m
+++ b/matlab/ms-sbvar/clean_ms_forecast_files.m
@@ -1,5 +1,5 @@
 function clean_ms_forecast_files(file_tag)
-% function clean_ms_forecast_files()
+% function clean_ms_forecast_files(file_tag)
 % removes MS forecast files
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/clean_ms_init_files.m b/matlab/ms-sbvar/clean_ms_init_files.m
index 95844acfa..13237b888 100644
--- a/matlab/ms-sbvar/clean_ms_init_files.m
+++ b/matlab/ms-sbvar/clean_ms_init_files.m
@@ -1,5 +1,5 @@
 function clean_ms_init_files(file_tag)
-% function clean_ms_init_files()
+% function clean_ms_init_files(file_tag)
 % removes MS initialization files
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/clean_ms_irf_files.m b/matlab/ms-sbvar/clean_ms_irf_files.m
index 2a5916b9f..f33ef3324 100644
--- a/matlab/ms-sbvar/clean_ms_irf_files.m
+++ b/matlab/ms-sbvar/clean_ms_irf_files.m
@@ -1,5 +1,5 @@
 function clean_ms_irf_files(file_tag)
-% function clean_ms_irf_files()
+% function clean_ms_irf_files(file_tag)
 % removes MS irf files
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/clean_ms_mdd_files.m b/matlab/ms-sbvar/clean_ms_mdd_files.m
index 7e025bc3b..30f367540 100644
--- a/matlab/ms-sbvar/clean_ms_mdd_files.m
+++ b/matlab/ms-sbvar/clean_ms_mdd_files.m
@@ -1,5 +1,5 @@
 function clean_ms_mdd_files(file_tag, pt)
-% function clean_ms_mdd_files()
+% function clean_ms_mdd_files(file_tag, pt)
 % removes MS mdd files
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/clean_ms_probabilities_files.m b/matlab/ms-sbvar/clean_ms_probabilities_files.m
index 785d33953..ebcc9ee4e 100644
--- a/matlab/ms-sbvar/clean_ms_probabilities_files.m
+++ b/matlab/ms-sbvar/clean_ms_probabilities_files.m
@@ -1,5 +1,5 @@
 function clean_ms_probabilities_files(file_tag)
-% function clean_ms_probabilities_files()
+% function clean_ms_probabilities_files(file_tag)
 % removes MS probabilities files
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/clean_ms_simulation_files.m b/matlab/ms-sbvar/clean_ms_simulation_files.m
index b2102aa0e..cccbf3e6d 100644
--- a/matlab/ms-sbvar/clean_ms_simulation_files.m
+++ b/matlab/ms-sbvar/clean_ms_simulation_files.m
@@ -1,5 +1,5 @@
 function clean_ms_simulation_files(file_tag)
-% function clean_ms_simulation_files()
+% function clean_ms_simulation_files(file_tag)
 % removes MS simulation files
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/clean_ms_variance_decomposition_files.m b/matlab/ms-sbvar/clean_ms_variance_decomposition_files.m
index 7c99526c9..dfa04a2cc 100644
--- a/matlab/ms-sbvar/clean_ms_variance_decomposition_files.m
+++ b/matlab/ms-sbvar/clean_ms_variance_decomposition_files.m
@@ -1,5 +1,5 @@
 function clean_ms_variance_decomposition_files(file_tag)
-% function clean_ms_variance_decomposition_files()
+% function clean_ms_variance_decomposition_files(file_tag)
 % removes MS variance decomposition files
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/clean_sbvar_files.m b/matlab/ms-sbvar/clean_sbvar_files.m
index 3c7b4f99e..15a49bf9e 100644
--- a/matlab/ms-sbvar/clean_sbvar_files.m
+++ b/matlab/ms-sbvar/clean_sbvar_files.m
@@ -1,5 +1,5 @@
 function clean_sbvar_files()
-%function clean_sbvar_files()
+% function clean_sbvar_files()
 % Remove files created by sbvar
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/create_dir.m b/matlab/ms-sbvar/create_dir.m
index ab5c3b472..8cca576da 100644
--- a/matlab/ms-sbvar/create_dir.m
+++ b/matlab/ms-sbvar/create_dir.m
@@ -1,5 +1,5 @@
 function create_dir(dirname)
-% function create_dir()
+% function create_dir(dirname)
 % creates directory if it doesn't exist
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/delete_dir_if_exists.m b/matlab/ms-sbvar/delete_dir_if_exists.m
index 7e771c2e2..89f74085e 100644
--- a/matlab/ms-sbvar/delete_dir_if_exists.m
+++ b/matlab/ms-sbvar/delete_dir_if_exists.m
@@ -1,5 +1,5 @@
 function delete_dir_if_exists(dirname)
-% function delete_dir_if_exists()
+% function delete_dir_if_exists(dirname)
 % removes directory if it exists
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/delete_if_exists.m b/matlab/ms-sbvar/delete_if_exists.m
index 2b8aa2288..7610b207b 100644
--- a/matlab/ms-sbvar/delete_if_exists.m
+++ b/matlab/ms-sbvar/delete_if_exists.m
@@ -1,5 +1,5 @@
 function delete_if_exists(fname)
-% function delete_if_exists()
+% function delete_if_exists(fname)
 % removes MS intermediary files
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/dyn_save_graph.m b/matlab/ms-sbvar/dyn_save_graph.m
index 1fcc06527..355b7f13e 100644
--- a/matlab/ms-sbvar/dyn_save_graph.m
+++ b/matlab/ms-sbvar/dyn_save_graph.m
@@ -1,5 +1,5 @@
 function dyn_save_graph(dirname,graph_name,graph_formats,TeX,names,texnames,caption)
-% function dyn_graph_save(graph_name,graph_formats,TeX)
+% function dyn_save_graph(dirname,graph_name,graph_formats,TeX,names,texnames,caption)
 % saves Dynare graphs
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/initialize_ms_sbvar_options.m b/matlab/ms-sbvar/initialize_ms_sbvar_options.m
index 3cf76e12a..c232d67ad 100644
--- a/matlab/ms-sbvar/initialize_ms_sbvar_options.m
+++ b/matlab/ms-sbvar/initialize_ms_sbvar_options.m
@@ -1,5 +1,5 @@
 function options_=initialize_ms_sbvar_options(M_, options_)
-%function initialize_ms_sbvar_options()
+% function options_=initialize_ms_sbvar_options(M_, options_)
 % sets ms sbvar options back to their default values
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/ms_compute_mdd.m b/matlab/ms-sbvar/ms_compute_mdd.m
index 20af6a150..ed931a336 100644
--- a/matlab/ms-sbvar/ms_compute_mdd.m
+++ b/matlab/ms-sbvar/ms_compute_mdd.m
@@ -1,6 +1,6 @@
 function [options_, oo_]=ms_compute_mdd(M_, options_, oo_)
-%function ms_compute_mdd()
-% MS Sbvar Compute Marginal Data Density
+% function [options_, oo_]=ms_compute_mdd(M_, options_, oo_)
+% Markov-switching SBVAR: Compute Marginal Data Density
 %
 % INPUTS
 %    M_:          (struct)    model structure
diff --git a/matlab/ms-sbvar/ms_compute_probabilities.m b/matlab/ms-sbvar/ms_compute_probabilities.m
index 0637289c6..07b951f65 100644
--- a/matlab/ms-sbvar/ms_compute_probabilities.m
+++ b/matlab/ms-sbvar/ms_compute_probabilities.m
@@ -1,6 +1,6 @@
 function [options_, oo_]=ms_compute_probabilities(M_, options_, oo_)
-%function ms_simulation()
-% MS Sbvar Compute Posterior Mode Regime Probabilities
+% function [options_, oo_]=ms_compute_probabilities(M_, options_, oo_)
+% Markov-switching SBVAR: Compute Posterior Mode Regime Probabilities
 %
 % INPUTS
 %    M_:          (struct)    model structure
diff --git a/matlab/ms-sbvar/ms_estimation.m b/matlab/ms-sbvar/ms_estimation.m
index c8870dee3..389e53275 100644
--- a/matlab/ms-sbvar/ms_estimation.m
+++ b/matlab/ms-sbvar/ms_estimation.m
@@ -1,6 +1,6 @@
 function [options_, oo_]=ms_estimation(M_, options_, oo_)
-%function ms_estimation()
-% MS Sbvar Estimation
+% function [options_, oo_]=ms_estimation(M_, options_, oo_)
+% Markov-switching SBVAR: Estimation
 %
 % INPUTS
 %    M_:          (struct)    model structure
diff --git a/matlab/ms-sbvar/ms_forecast.m b/matlab/ms-sbvar/ms_forecast.m
index 600576480..76d420a98 100644
--- a/matlab/ms-sbvar/ms_forecast.m
+++ b/matlab/ms-sbvar/ms_forecast.m
@@ -1,6 +1,6 @@
 function [options_, oo_]=ms_forecast(M_, options_, oo_)
-%function ms_forecast()
-% MS-SBVAR Forecast
+% function [options_, oo_]=ms_forecast(M_, options_, oo_)
+% Markov-switching SBVAR: Forecast
 %
 % INPUTS
 %    M_:          (struct)    model structure
diff --git a/matlab/ms-sbvar/ms_irf.m b/matlab/ms-sbvar/ms_irf.m
index 03844534e..d242b0201 100644
--- a/matlab/ms-sbvar/ms_irf.m
+++ b/matlab/ms-sbvar/ms_irf.m
@@ -1,6 +1,6 @@
-function [options_, oo_]=ms_irf(varlist,M_, options_, oo_)
-%function ms_irf()
-% MS-SBVAR Impulse Response Function
+function [options_, oo_]=ms_irf(varlist, M_, options_, oo_)
+% function [options_, oo_]=ms_irf(varlist, M_, options_, oo_)
+% Markov-switching SBVAR: Impulse Response Function
 %
 % INPUTS
 %    varlist:     (chararray) list of selected endogenous variables
diff --git a/matlab/ms-sbvar/ms_sbvar_setup.m b/matlab/ms-sbvar/ms_sbvar_setup.m
index 7132be7a2..183469af1 100644
--- a/matlab/ms-sbvar/ms_sbvar_setup.m
+++ b/matlab/ms-sbvar/ms_sbvar_setup.m
@@ -1,5 +1,5 @@
 function ms_sbvar_setup(options_)
-%function ms_sbvar_setup()
+% function ms_sbvar_setup(options_)
 % does the general file initialization for ms sbvar
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/ms_simulation.m b/matlab/ms-sbvar/ms_simulation.m
index d4002e3f7..a5ffe36cb 100644
--- a/matlab/ms-sbvar/ms_simulation.m
+++ b/matlab/ms-sbvar/ms_simulation.m
@@ -1,6 +1,6 @@
 function [options_, oo_]=ms_simulation(M_, options_, oo_)
-%function ms_simulation()
-% MS Sbvar Simulation
+% function [options_, oo_]=ms_simulation(M_, options_, oo_)
+% Markov-switching SBVAR: Simulation
 %
 % INPUTS
 %    M_:          (struct)    model structure
diff --git a/matlab/ms-sbvar/ms_variance_decomposition.m b/matlab/ms-sbvar/ms_variance_decomposition.m
index ceb31a439..89a8a229f 100644
--- a/matlab/ms-sbvar/ms_variance_decomposition.m
+++ b/matlab/ms-sbvar/ms_variance_decomposition.m
@@ -1,6 +1,6 @@
 function [options_, oo_]=ms_variance_decomposition(M_, options_, oo_)
-%function ms_variance_decomposition()
-% MS-SBVAR Variance Decomposition
+% function [options_, oo_]=ms_variance_decomposition(M_, options_, oo_)
+% Markov-switching SBVAR: Variance Decomposition
 %
 % INPUTS
 %    M_:          (struct)    model structure
diff --git a/matlab/ms-sbvar/plot_ms_forecast.m b/matlab/ms-sbvar/plot_ms_forecast.m
index c68f87952..b537fc039 100644
--- a/matlab/ms-sbvar/plot_ms_forecast.m
+++ b/matlab/ms-sbvar/plot_ms_forecast.m
@@ -1,5 +1,5 @@
 function plot_ms_forecast(M_,options_,forecast,title_,save_graph_formats,TeX)
-% function [] = plot_ms_forecast(forecast,names)
+% function plot_ms_forecast(M_,options_,forecast,title_,save_graph_formats,TeX)
 % plots the forecast from the output from a ms-sbvar
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/plot_ms_irf.m b/matlab/ms-sbvar/plot_ms_irf.m
index 0ae181ba6..5d055a87a 100644
--- a/matlab/ms-sbvar/plot_ms_irf.m
+++ b/matlab/ms-sbvar/plot_ms_irf.m
@@ -1,5 +1,5 @@
 function plot_ms_irf(M_, options_, irf, names, title_, varlist)
-% function [] = plot_ms_irf(irf,names)
+% function plot_ms_irf(M_, options_, irf, names, title_, varlist)
 % plots the impulse responses from the output from a ms-sbvar
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/plot_ms_probabilities.m b/matlab/ms-sbvar/plot_ms_probabilities.m
index 06afefaa0..79c7876b6 100644
--- a/matlab/ms-sbvar/plot_ms_probabilities.m
+++ b/matlab/ms-sbvar/plot_ms_probabilities.m
@@ -1,5 +1,5 @@
 function plot_ms_probabilities(computed_probabilities, options_)
-% function plot_ms_probabilities(computed_probabilities)
+% function plot_ms_probabilities(computed_probabilities, options_)
 % Plots the regime probablities for each graph
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/plot_ms_variance_decomposition.m b/matlab/ms-sbvar/plot_ms_variance_decomposition.m
index 29ce4b8d9..2e7832a5b 100644
--- a/matlab/ms-sbvar/plot_ms_variance_decomposition.m
+++ b/matlab/ms-sbvar/plot_ms_variance_decomposition.m
@@ -1,5 +1,5 @@
-function plot_ms_variance_decomposition(M_, options_, vd, title_, graph_save_formats, ...
-                                        TeX, varargin)
+function plot_ms_variance_decomposition(M_, options_, vd, title_, graph_save_formats, TeX, varargin)
+% function plot_ms_variance_decomposition(M_, options_, vd, title_, graph_save_formats, TeX, varargin)
 % plot the variance decomposition of shocks
 %
 % Inputs
diff --git a/matlab/ms-sbvar/set_file_tags.m b/matlab/ms-sbvar/set_file_tags.m
index a1b933375..cacd91e69 100644
--- a/matlab/ms-sbvar/set_file_tags.m
+++ b/matlab/ms-sbvar/set_file_tags.m
@@ -1,5 +1,5 @@
 function [options_]=set_file_tags(options_)
-%function set_file_tags()
+% function [options_]=set_file_tags(options_)
 % Sets the appropriate file tags for first type of mex function
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/set_ms_estimation_file.m b/matlab/ms-sbvar/set_ms_estimation_file.m
index d4ce5506e..3aa307a78 100644
--- a/matlab/ms-sbvar/set_ms_estimation_file.m
+++ b/matlab/ms-sbvar/set_ms_estimation_file.m
@@ -1,5 +1,5 @@
 function [options_, oo_]=set_ms_estimation_file(file_tag, options_, oo_)
-%function set_ms_estimation_file()
+% function [options_, oo_]=set_ms_estimation_file(file_tag, options_, oo_)
 % Set options_.ms.free_param_file based on user input
 %
 % INPUTS
diff --git a/matlab/ms-sbvar/set_ms_simulation_file.m b/matlab/ms-sbvar/set_ms_simulation_file.m
index 4760161e1..75e815b47 100644
--- a/matlab/ms-sbvar/set_ms_simulation_file.m
+++ b/matlab/ms-sbvar/set_ms_simulation_file.m
@@ -1,5 +1,5 @@
 function options_=set_ms_simulation_file(options_)
-%function set_ms_simulation_file()
+% function options_=set_ms_simulation_file(options_)
 % Set options_.ms.mh_file based on user input
 %
 % INPUTS
-- 
GitLab