add missing doc comments

This commit is contained in:
Eliot Jones
2018-01-10 20:31:38 +00:00
parent b2b5646208
commit be98b1f8e4
3 changed files with 15 additions and 4 deletions

View File

@@ -50,6 +50,9 @@
PointSize = pointSize; PointSize = pointSize;
} }
/// <summary>
/// Produces a string representation of the letter and its position.
/// </summary>
public override string ToString() public override string ToString()
{ {
return $"{Location} {Width} {Value} {FontName} {PointSize}"; return $"{Location} {Width} {Value} {FontName} {PointSize}";

View File

@@ -32,6 +32,9 @@
[NotNull] [NotNull]
internal Pages Pages { get; } internal Pages Pages { get; }
/// <summary>
/// The metadata associated with this document.
/// </summary>
[NotNull] [NotNull]
public DocumentInformation Information { get; } public DocumentInformation Information { get; }
@@ -89,6 +92,10 @@
return Pages.GetPage(pageNumber); return Pages.GetPage(pageNumber);
} }
/// <inheritdoc />
/// <summary>
/// Dispose the <see cref="T:UglyToad.PdfPig.PdfDocument" /> and close any unmanaged resources.
/// </summary>
public void Dispose() public void Dispose()
{ {
try try

View File

@@ -8,15 +8,16 @@
<Authors>UglyToad</Authors> <Authors>UglyToad</Authors>
<Title>ToadPDF</Title> <Title>ToadPDF</Title>
<Description>Reads text content from PDF documents.</Description> <Description>Reads text content from PDF documents.</Description>
<PackageLicenseUrl>https://raw.githubusercontent.com/UglyToad/Pdf/master/LICENSE</PackageLicenseUrl> <PackageLicenseUrl>https://raw.githubusercontent.com/UglyToad/PdfPig/master/LICENSE</PackageLicenseUrl>
<PackageProjectUrl>https://github.com/UglyToad/Pdf</PackageProjectUrl> <PackageProjectUrl>https://github.com/UglyToad/PdfPig</PackageProjectUrl>
<PackageTags>PDF;Reader;Document;Adobe;PDFBox;PdfPig</PackageTags> <PackageTags>PDF;Reader;Document;Adobe;PDFBox;PdfPig</PackageTags>
<RepositoryUrl>https://github.com/UglyToad/Pdf</RepositoryUrl> <RepositoryUrl>https://github.com/UglyToad/PdfPig</RepositoryUrl>
<GenerateDocumentationFile>true</GenerateDocumentationFile> <GenerateDocumentationFile>true</GenerateDocumentationFile>
<Version>0.0.1-alpha-001</Version> <Version>0.0.1-alpha-001</Version>
<AssemblyVersion>0.0.1.1</AssemblyVersion> <AssemblyVersion>0.0.1.1</AssemblyVersion>
<FileVersion>0.0.1.1</FileVersion> <FileVersion>0.0.1.1</FileVersion>
<PackageIconUrl>https://raw.githubusercontent.com/UglyToad/Pdf/master/documentation/pdfpig.png</PackageIconUrl> <PackageIconUrl>https://raw.githubusercontent.com/UglyToad/PdfPig/master/documentation/pdfpig.png</PackageIconUrl>
<Product>PdfPig</Product>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>