korzh / aistdoc Goto Github PK

If we don't have any @Significant functions or methods to list in the excerpt - then it must be cleared because auto-generated text for excerpts in class or "Functions" sections sucks :).

If there are no @Significant "tags" in the corresponded class/namespace/module then we should take first 10 (optional?) items to put them in Excerpt as a bullet list

If some function or method is marked with @Significant tag then its name (with a link to the article) will be listed in the excerpt for the corresponding class section or "Functions" section for the package.

I installed aistdoc and tried to create the config file and I am getting this error:

c:\Temp>aistdoc --create:cs:dotnettips
aistdoc utility 2.0.3.1 (c) Aistant 2018-2019
Current folder: c:\Temp
Specify --help for a list of available options and commands.

Unhandled Exception: McMaster.Extensions.CommandLineUtils.UnrecognizedCommandParsingException: Unrecognized option '--create:cs:dotnettips'
at McMaster.Extensions.CommandLineUtils.CommandLineProcessor.HandleUnexpectedArg(String argTypeName, String argValue)
at McMaster.Extensions.CommandLineUtils.CommandLineProcessor.ProcessOption(OptionArgument arg)
at McMaster.Extensions.CommandLineUtils.CommandLineProcessor.ProcessNext()
at McMaster.Extensions.CommandLineUtils.CommandLineProcessor.Process()
at McMaster.Extensions.CommandLineUtils.CommandLineApplication.Parse(String[] args)
at McMaster.Extensions.CommandLineUtils.CommandLineApplication.ExecuteAsync(String[] args, CancellationToken cancellationToken)
at McMaster.Extensions.CommandLineUtils.CommandLineApplication.Execute(String[] args)
at aistdoc.Program.Main(String[] args) in C:\azuredevops-agents\korzhdev_work\19\s\src\aistdoc\Program.cs:line 20

c:\Temp>

To support generating documentation for .net461 and other assemblies, we can rewrite the loading part using MetaDataLoadContext. Here is an article https://docs.microsoft.com/en-us/dotnet/standard/assembly/inspect-contents-using-metadataloadcontext

aistdoc repeats some commits during generating changelog. It is possible when we merge a branch, that has been in development for a long time.

For example for version 7.0.0 we have such changes:

[Fix]: NullReference exception in case of "no path between 2 tables" situation
[Fix]: NullReference exception on queries with InJoin conditions

But for version 5.4.6 there are also such changes:

[Fix]: NullReference exception in case of "no path between 2 tables" situation
[Fix]: NullReference exception on queries with InJoin conditions

More by this link: https://korzh.com/easyquery/docs/changelog

Possible fix:
Now we use splice between two tags. I think we should also use creationdate and time of previous tag and query commits by it

If it's 'true' aistdoc should not add the heading (like ## Version xx.xx) at the begging of the changelog for a particular version.

I think it is possible to add squash commits support because the squash commit message looks like

Main commit message

    Squashed commit message 1
    Squashed commit message 2
    Squashed commit message 3

Squashed commits are useful to decrease the number of use-less commits in repository