docSG

by Tim C. Lueth, SG-Lib Toolbox: SolidGeometry 5.6 - CODING/DEVELOP
Introduced first in SolidGeometry 5.2, Creation date: 2022-12-15, Last change: 2025-09-15

just shows the documentation of the calling fnct

Description

cam be used as last line in nargout block, to support rare used function

With SG-Lib 5.5, it is possible to use an argument too.

See Also:

Example Illustration

Syntax

docSG([fname])

Input Parameter

fname: optinal fnc name if the caller is not desired

Examples


docSG          % Documentation of the calling fnc
docSG CPL2cw   % Web documentation by mathworks

Copyright 2022-2025 Tim C. Lueth. All rights reserved. The code is the property of Tim C. Lueth and may not be redistributed or modified without explicit written permission. This software may be used free of charge for academic research and teaching purposes only. Commercial use, redistribution, modification, or reverse engineering is strictly prohibited. Access to source code is restricted and granted only under specific agreements. For licensing inquiries or commercial use, please contact: Tim C. Lueth

Algorithm (Workflow)

This function, docSG, is designed to display documentation for a specified function or the calling function within the SG-Library. It was developed by Tim Lueth and is part of the VLFL-Lib, introduced in SolidGeometry 5.2 and updated in SG-Lib 5.5.

Input Parameters

fname: An optional parameter representing the function name for which documentation is desired. If not provided, the function will attempt to document the calling function.

Algorithm Steps

The function begins by retrieving the function name using getfuncparams, which processes the input arguments. If no arguments are provided, it defaults to an empty string.
A base URL for MathWorks documentation is defined as mwurl.
The function checks the number of input arguments using nargin:

If nargin is 0, it implies no specific function name was provided. The function then:
- Retrieves the title of the calling function using titleofcaller.
- Calls docTL with the calling function's name to display its documentation.
- Opens the local SG-Library help index in a web browser.
- Brings the command window to the front using commandwindowTL.
If a function name is provided as an argument, the function constructs a URL to the MathWorks documentation search page for the specified function name and opens it in a web browser.

Algorithm explaination created using ChatGPT on 2025-08-19 00:31. (Please note: No guarantee for the correctness of this explanation)

Last html export of this page out of FM database by TL: 2025-09-21