Class TlbHelpReader

Provides static methods to get helpstring from TLB-files

Inheritance

object

TlbHelpReader

Namespace: BuildSystem.TlbDoc

Assembly: BuildSystem.ProjectList.dll

Syntax

public static class TlbHelpReader : Object

Methods

GetHelpStrings(string, ILogger?)

Load TLB-file using LoadTypeLib from "oleaut32.dll". And later analyze it using System.Runtime.InteropServices.ComTypes.ITypeInfo. Reads helpstring section for each type, provided in TLB. See format in ParseHelpString(string, ILogger?)

Declaration

public static Dictionary<string, string> GetHelpStrings(string tlbPath, ILogger? logger = null)

Parameters

Type	Name	Description
string	tlbPath	Path to analyzing TLB-file
ILogger	logger	Logging object

Returns

Type	Description
System.Collections.Generic.Dictionary<,><string, string>	Dictionary, where key is full path to type (like in C#) and value is its comment

ParseHelpString(string, ILogger?)

Helpstring should be formatted to be read correctly:

1. First text is global summary text
2. Params info starts from @param ParamName - like in Java
3. Return value starts from @returns - like in Java

Declaration

public static string ParseHelpString(string helpString, ILogger? logger = null)

Parameters

Type	Name	Description
string	helpString
ILogger	logger

Returns

Type	Description
string	String line as in C# xml files with doc