Documentation for: Test.xlsm
Document: ThisWorkbook
General Information
Author:
Magnus Dahlberg / MDAB
Copyright MDAB 2013 -

Version:
1.0
2013-10-08
Base version.
This line shows up as a second line in the last cell of this Version table.
It is because the line "Base version." ends with " &". " &" makes it possible to continue with new lines in the same cell (if the cell is the last in the row).
Using " &_" is like " &" but results in continuation of the line.

This Workbook is only used for testing the features of "MD - Tools".

One of the features is extracting Documentation from the code. A documentation block starts with the characters "'/**" in the beginning of a line and ends with "'*/" in the beginning of another line.

Adding a continuation mark " &_" at the end of a documentation comment line lets the following line continue as if there was no new line (as this line that start with: the following...).
This applies only for output to HTML.

Using HTML markup in the documentation lines shows up in the HTML Documentation. E.g.
the following three words "How are you?" should show up in bold as they are
surrounded with the markup: <b> and </b>.


Sheet: Sheet1 (Just a Sheet Name)
General Information
This is the "Just a Sheet Name" sheet.
You may add Date and Time entries via the macro "OutputDateAndTime" using the current Date and Time format.

Private Sub cbnTestButton_Click
This routine executes when the button "A Test Button" is clicked in the "Just a Sheet Name" sheet.

Calling:
A form that shows current Date and Time format and lets you both test the format and store it.

Form: frmSetDateAndTimeFormat
General Information
A user form with which you can set the Date and Time format.
You can also output an example in the selected cell.

Private Sub UserForm_Initialize
Initilizes a public DateAndTime object and sets the textbox to its value.

Called from:
Executed when the button "A Test Button" is clicked in the "Just a Sheet Name" sheet.

Calling:
Gets current Date and Time format.

Private Sub cbnSetFormat_Click
Sets the currently used Date and Time format and stores it for future use.

Calling:
Saves Date and Time format from the textbox.

Private Sub cbnShowFormat_Click
Outputs current Date and Time format and an example of it using current time.

Calling:
A routine that shows the current format in text and an example of its use with the current time.

Module: MD_Macros
General Information
This is a test module used to evaluate how "MD-Tools" works with Add/Remove of Linenumbers and Extract/Delete Documentation.

Public Sub OutputDateAndTime
Using the cell above the currently selected cell it outputs a header that shows how date and time is formatted.
The cell below the header (=currently selected cell) receives the current date and time.

Called from:
A button in the form that outputs an example using this routine.

Calling:
Get the current Date and Time format.

Class: DateAndTime
General Information
This class controls how the output format for Date and Time is built.
It is currently only implemented for standard european time format.

Private Sub Class_Initialize
Initializes the output Format for Date and Time.

Public Property Get DatFormat As String
Returns the Date and Time Format that is currently used.

Called from:
Used to show the Date and Time format in the textbox of the form.
Used to show the Date and Time format in the textbox of the form.
Used by this routine to output an example of the current Date and Time format.

Public Property Let DatFormat
Sets the Date and Time format.

Parameters:
NewDateAndTimeFormat As String
The new Date and Time format.

Called from:
A button in the form that sets the Date and Time format.
The value is saved in the "Trust Me" sheet for future use.

Public Function ShowUpDocumentationProcedure As Boolean
A public subroutine that outputs first and second parameter to messageboxes.

Parameters:
Whatever As String
Can be just whatever.
Specific As String
Must be something specific.


----- End of Documentation -----