search

Mr-Markus / ZigbeeNet

A .NET Standard library for working with ZigBee
Eclipse Public License 1.0
131 stars 47 forks source link

Adjust CodeGenerator to generate XML comments #38 #42

Closed ndili561 closed 5 years ago

Mr-Markus commented 5 years ago

Thanks for your work again.

It generates XML comments like this: image

And here it is mixed

image

That's not really useful 😐

Mr-Markus commented 5 years ago

There are still misstakes:

image

Please get all /// in one column and remove empty lines. Also check that the only contains the attribute name and that the desription is between the tags.

I also saw that the {@link XXX} is still there. this should be replaced with the

See here for further information: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments

Commiting the CodeGenerator class is enough for your work. I would run the generator if result is ok. But please test your result locally by looking at it before you commit...

Mr-Markus commented 5 years ago

Because it still doesn't works after three tries and code was not tested and reviewed by you locally this PR will be closed