Skip to content

Commit 89b3cb6

Browse files
committed
Merge branch 'verinfo'
2 parents f4a9547 + 26486ee commit 89b3cb6

34 files changed

+243
-225
lines changed

Docs/VerInfo/API.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

Docs/VerInfo/API/TPJVersionInfo.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

Docs/VerInfo/Examples.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

Docs/VerInfo/Overview.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Documentation of the following projects has been completed:
2424
| Resource File Unit | <https://lib-docs.delphidabbler.com/ResFile/> |
2525
| Shell Folders Unit | <https://lib-docs.delphidabbler.com/ShellFolders/> |
2626
| System Information Unit | <https://lib-docs.delphidabbler.com/SysInfo/> |
27+
| Version Information Component | <https://lib-docs.delphidabbler.com/VerInfo/> |
2728
| Window State Components | <https://lib-docs.delphidabbler.com/WdwState/> |
2829

2930
Documentation of the following, unreleased, project is under construction:

VerInfo/3/API.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# [Version Information Component](../index.md) Programmers Guide
2+
3+
**Applies to:** ~>3.0
4+
5+
## Introduction
6+
7+
This section of the _Version Information Component_ documentation describes the API exposed by the unit to programmers.
8+
9+
## Contents
10+
11+
### Units
12+
13+
| Unit | Description |
14+
|:-----|:------------|
15+
| _PJVersionInfo_ | The only unit in this project. Contains all the types and routines noted below. |
16+
17+
### Types
18+
19+
| Types | Description |
20+
|:------|:------------|
21+
| [_TPJVersionInfo_](./API/TPJVersionInfo.md) | Version information component class. |
22+
| [_TPJVersionNumber_](./API/TPJVersionNumber.md) | Record that encapsulates a version number. |
23+
24+
### Other
25+
26+
| Item | Description |
27+
|:-----|:------------|
28+
| [Routines](./API/Routines.md) | Public helper routines. |
29+
| _Register_ |**Do not use**. Component registration routine, called by the Delphi IDE to register the component. |
30+
31+
## Conventions
32+
33+
This documentation complies with [these conventions](../../common/conventions.md).
34+
35+
## Links
36+
37+
* [Overview](./Overview.md)
38+
* [Examples](./Examples.md)

Docs/VerInfo/API/Routines.md renamed to VerInfo/3/API/Routines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ function VerNumToStr(const Ver: TPJVersionNumber): string;
1616

1717
### VerNumToStr description
1818

19-
Converts the given [_TPJVersionNumber_](TPJVersionNumber.md) record into a dotted quad string and returns it.
19+
Converts the given [_TPJVersionNumber_](./TPJVersionNumber.md) record into a dotted quad string and returns it.
2020

2121
### VerNumToStr example
2222

@@ -38,7 +38,7 @@ end;
3838

3939
### VerNumToStr remarks
4040

41-
Users of Delphi 2006 and later can simply assign a [_TPJVersionNumber_](TPJVersionNumber.md) record to a string to get exactly the same effect. There is never any need to call _VerNumToStr_.
41+
Users of Delphi 2006 and later can simply assign a [_TPJVersionNumber_](./TPJVersionNumber.md) record to a string to get exactly the same effect. There is never any need to call _VerNumToStr_.
4242

4343
## CompareVerNums
4444

Docs/VerInfo/API/TPJVersionInfo-CharSetCode.md renamed to VerInfo/3/API/TPJVersionInfo-CharSetCode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Read only property that returns the code of the character set used by the curren
1616

1717
If the current file has no version information then `0` is returned. To get a description of the character set use the [_CharSet_](./TPJVersionInfo-CharSet.md) property instead.
1818

19-
See the ''charsetID'' section of the [MSDN VERSIONINFO](http://msdn.microsoft.com/en-us/library/aa381058) topic for information about these codes.
19+
See the _charsetID_ section of the [VERSIONINFO resource](https://learn.microsoft.com/en-gb/windows/win32/menurc/versioninfo-resource) documentation.

0 commit comments

Comments
 (0)