search

aianlinb / LibGGPK3

Library for Content.ggpk of game PathOfExile (Rewrite of LibGGPK2)
GNU Affero General Public License v3.0
75 stars 21 forks source link

Published LibGGPK3 has no comments #2

Closed Urantij closed 1 year ago

Urantij commented 1 year ago

If you install LibGGPK3 from nuget, you wont have any comments. You can add <GenerateDocumentationFile>true</GenerateDocumentationFile> line within PropertyGroup element in .csproj file to include comments. You can also add <NoWarn>1591</NoWarn> To disable warning about not having comments on public props.

This will improve the usability of the library.

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <Description>Library for Content.ggpk of game PathOfExile (Rewrite of LibGGPK2)</Description>
        <GenerateDocumentationFile>true</GenerateDocumentationFile>
        <NoWarn>1591</NoWarn>
    </PropertyGroup>
</Project>
aianlinb commented 1 year ago

Thanks, I'll add this in next version.