From c1a6d24deb30fde630a4a8f44b9ce3dfc4e7263f Mon Sep 17 00:00:00 2001
From: Thomas Lambert <t.lambert@uliege.be>
Date: Mon, 5 Sep 2022 18:30:25 +0200
Subject: [PATCH] doc: better help footer
---
+af_tools/@Airfoil/Airfoil.m | 13 ++++++-------
+af_tools/@Airfoil/addextremereynolds.m | 9 ++++++---
+af_tools/@Polar/Polar.m | 14 ++++++--------
+af_tools/@Polar/getcoeffs.m | 8 ++++++--
+af_tools/@Polar/loadpolar.m | 9 ++++++---
+af_tools/@Polar/polypolar.m | 11 ++++++-----
+af_tools/extendpolar.m | 13 ++++++-------
+af_tools/findcllinearrange.m | 13 ++++++-------
+af_tools/findstall.m | 13 ++++++-------
+af_tools/findzerolift.m | 13 ++++++-------
+af_tools/formatairfoilcoord.m | 12 ++++++------
+af_tools/nacaairfoil.m | 13 ++++++-------
+af_tools/nacacamber.m | 13 ++++++-------
+af_tools/plotpolars.m | 10 ++++++----
+af_tools/xf2mat.m | 12 ++++++------
15 files changed, 90 insertions(+), 86 deletions(-)
diff --git a/+af_tools/@Airfoil/Airfoil.m b/+af_tools/@Airfoil/Airfoil.m
index c080b8b..0a0a7ca 100644
--- a/+af_tools/@Airfoil/Airfoil.m
+++ b/+af_tools/@Airfoil/Airfoil.m
@@ -8,9 +8,6 @@ classdef Airfoil < handle
% - the airofil lower surface coordinates
% - a structure containing the original airfoil polars (obtained using xf2mat)
% - a structure containing the extended airfoil polars (obtained using extendpolar)
- %
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Usage:
@@ -33,13 +30,15 @@ classdef Airfoil < handle
%
% See also: XF2MAT, EXTENDPOLAR.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
properties
diff --git a/+af_tools/@Airfoil/addextremereynolds.m b/+af_tools/@Airfoil/addextremereynolds.m
index fe3b79e..5fc877e 100644
--- a/+af_tools/@Airfoil/addextremereynolds.m
+++ b/+af_tools/@Airfoil/addextremereynolds.m
@@ -8,12 +8,15 @@ function obj = addextremereynolds(obj)
% Note:
% If we have only one polar (i.e. one Reynolds), then this method does not do anything.
% -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
% Defaults extreme Reynolds
diff --git a/+af_tools/@Polar/Polar.m b/+af_tools/@Polar/Polar.m
index 74f0bf8..d4c4448 100644
--- a/+af_tools/@Polar/Polar.m
+++ b/+af_tools/@Polar/Polar.m
@@ -5,9 +5,6 @@ classdef Polar
%
% The class also implements quick shortcuts for the more generic functions of af_tools, such
% as findcllinearrange, findstall or findzerolift.
- %
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Properties:
@@ -38,15 +35,16 @@ classdef Polar
%
% See also: af_tools.xf2mat.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
-
properties
airfoil (1, :) cell
reynolds (1, :) double {mustBeNonnegative}
diff --git a/+af_tools/@Polar/getcoeffs.m b/+af_tools/@Polar/getcoeffs.m
index 210f0e8..e4da05f 100644
--- a/+af_tools/@Polar/getcoeffs.m
+++ b/+af_tools/@Polar/getcoeffs.m
@@ -30,12 +30,16 @@ function [cl, cd, cm] = getcoeffs(self, aoa, re, polarType)
% [cl, cd, cm] = Airfoil.getcoeffs([0.17,0.18], [1e5,1e6])
%
% See also: Airfoil.
- % -----
+ %
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% MIT License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
narginchk(3, 4);
diff --git a/+af_tools/@Polar/loadpolar.m b/+af_tools/@Polar/loadpolar.m
index f5b7779..83bfe18 100644
--- a/+af_tools/@Polar/loadpolar.m
+++ b/+af_tools/@Polar/loadpolar.m
@@ -20,12 +20,15 @@ function obj = loadpolar(polarFile)
% See also: af_tools.Polar.
%
% -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
% Load the file
diff --git a/+af_tools/@Polar/polypolar.m b/+af_tools/@Polar/polypolar.m
index cd0b9cf..bc9244f 100644
--- a/+af_tools/@Polar/polypolar.m
+++ b/+af_tools/@Polar/polypolar.m
@@ -21,15 +21,16 @@ function Obj = polypolar(polyCl, polyCd)
%
% See also: af_tools.Polar.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
-
% Defaults and constants
DEF.AOA_STEP = 0.5;
DEF.AIRFOIL = {'Polynomial'};
diff --git a/+af_tools/extendpolar.m b/+af_tools/extendpolar.m
index 88c26e4..2f53f6a 100644
--- a/+af_tools/extendpolar.m
+++ b/+af_tools/extendpolar.m
@@ -15,9 +15,6 @@ function [alpha_ext, c_l_ext, c_d_ext] = extendpolar(varargin)
% IMPORTANT:
% To be extended, the input polar must AT LEAST containt the points where AOA = 0 deg and
% stall point.
- %
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Usage:
@@ -62,13 +59,15 @@ function [alpha_ext, c_l_ext, c_d_ext] = extendpolar(varargin)
%
% See also: XF2MAT, PLOTPOLARS.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
% Check number of inputs
diff --git a/+af_tools/findcllinearrange.m b/+af_tools/findcllinearrange.m
index 566b320..55cc04d 100644
--- a/+af_tools/findcllinearrange.m
+++ b/+af_tools/findcllinearrange.m
@@ -14,9 +14,6 @@ function [alphaRange, c_lRange, c_lSlope] = findcllinearrange(varargin)
%
% If extended polars are used as input (see EXTENDPOLAR), the function will only look for the
% zero-lift angle in the range of [-30, 30] deg.
- %
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Usage:
@@ -48,13 +45,15 @@ function [alphaRange, c_lRange, c_lSlope] = findcllinearrange(varargin)
%
% See also: XF2MAT, FINDSTALL, FINDZEROLIFT.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
narginchk(0, 2);
diff --git a/+af_tools/findstall.m b/+af_tools/findstall.m
index c39f154..7bfc8b7 100644
--- a/+af_tools/findstall.m
+++ b/+af_tools/findstall.m
@@ -15,9 +15,6 @@ function [alpha_s, c_l_s, c_d_s] = findstall(varargin)
%
% If extended polars are used as input (see EXTENDPOLAR), the function will only look for the
% zero-lift angle in the range of [0, 30] deg.
- %
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Usage:
@@ -50,13 +47,15 @@ function [alpha_s, c_l_s, c_d_s] = findstall(varargin)
%
% See also: XF2MAT, FINDZEROLIFT, FINDCLLINEARRANGE.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
narginchk(0, 3);
diff --git a/+af_tools/findzerolift.m b/+af_tools/findzerolift.m
index ddf652b..01f5863 100644
--- a/+af_tools/findzerolift.m
+++ b/+af_tools/findzerolift.m
@@ -14,9 +14,6 @@ function [alpha_0, c_d_0] = findzerolift(varargin)
%
% If extended polars are used as input (see EXTENDPOLAR), the function will only look for the
% zero-lift angle in the range of [-30, 30] deg.
- %
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Usage:
@@ -53,13 +50,15 @@ function [alpha_0, c_d_0] = findzerolift(varargin)
%
% See also: XF2MAT, FINDSTALL, FINDCLLINEARRANGE.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
narginchk(0, 3);
diff --git a/+af_tools/formatairfoilcoord.m b/+af_tools/formatairfoilcoord.m
index 7d684b9..78273d8 100644
--- a/+af_tools/formatairfoilcoord.m
+++ b/+af_tools/formatairfoilcoord.m
@@ -24,9 +24,6 @@ function Dat = formatairfoilcoord(varargin)
%
% Note:
% This function can be used on many files at once in order to speed-up the process.
- %
- % <a href="https://gitlab.uliege.be/thlamb/airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/thlamb/airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Usage:
@@ -77,12 +74,15 @@ function Dat = formatairfoilcoord(varargin)
% -----
% UIUC Airfoil Database: https://m-selig.ae.illinois.edu/ads/coord_database.html
% -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
narginchk(0, 8);
diff --git a/+af_tools/nacaairfoil.m b/+af_tools/nacaairfoil.m
index 098bec2..bcb2d19 100644
--- a/+af_tools/nacaairfoil.m
+++ b/+af_tools/nacaairfoil.m
@@ -10,9 +10,6 @@ function [coord] = nacaairfoil(varargin)
% value of nPoints. This is because the upper and lower surfaces will have the same number of
% points, and the leading edge is counted twice (as the first and last element to close the
% shape) while the trailing edge is counted once.
- %
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Usage:
@@ -60,13 +57,15 @@ function [coord] = nacaairfoil(varargin)
%
% See also: NACACAMBER.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
narginchk(0, 6);
diff --git a/+af_tools/nacacamber.m b/+af_tools/nacacamber.m
index d899f93..94ec3b8 100644
--- a/+af_tools/nacacamber.m
+++ b/+af_tools/nacacamber.m
@@ -3,9 +3,6 @@ function [coord, gradY] = nacacamber(varargin)
% By default, the camberline is generated with 100 points distributed following a half-cosine
% rule in order to be finer at the leading and trailing edges.
% See below for details on how to override the defaults.
- %
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Usage:
@@ -41,13 +38,15 @@ function [coord, gradY] = nacacamber(varargin)
%
% See also: NACAAIRFOIL.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
narginchk(0, 4);
diff --git a/+af_tools/plotpolars.m b/+af_tools/plotpolars.m
index 8c5d9c9..8766059 100644
--- a/+af_tools/plotpolars.m
+++ b/+af_tools/plotpolars.m
@@ -56,13 +56,15 @@ function plotpolars(varargin)
%
% See also: XF2MAT, EXTENDPOLAR.
%
- % -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
narginchk(0, 4);
diff --git a/+af_tools/xf2mat.m b/+af_tools/xf2mat.m
index 31d7bd7..dfafffb 100644
--- a/+af_tools/xf2mat.m
+++ b/+af_tools/xf2mat.m
@@ -19,9 +19,6 @@ function Polar = xf2mat(varargin)
% If the option 'trimAoas' is set to true, the function will find the largest common range of
% angles of attack accross the various input polars and trim everything to that range. This
% prevents NaN values in the polars, but removes some data from the most complete inputs.
- %
- % <a href="https://gitlab.uliege.be/thlamb/airfoil_toolbox">Documentation (README)</a>
- % <a href="https://gitlab.uliege.be/thlamb/airfoil_toolbox/-/issues">Report an issue</a>
% -----
%
% Usage:
@@ -66,12 +63,15 @@ function Polar = xf2mat(varargin)
% XFOIL: http://web.mit.edu/drela/Public/web/xfoil/
% XFLR5: https://www.xflr5.tech/xflr5.htm
% -----
+ % <a href="https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox">Documentation (online)</a>
+
+ % -------------------------------------------
% (c) Copyright 2022 University of Liege
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
- % Apache 2.0 License
- % https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
-
+ % MIT License
+ % Repo: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox
+ % Issues: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
% ----------------------------------------------------------------------------------------------
narginchk(0, 6);
--
GitLab