Rhisis icon indicating copy to clipboard operation
Rhisis copied to clipboard

Rewrite summaries for packet structures.

Open Eastrall opened this issue 5 years ago • 2 comments

@Kaev developped a tool that parses the comment summaries of the packets and creates a Wiki documentation of implemented packets.

Some packet summaries need a rewrite so it can be well documented.

For example: https://github.com/Eastrall/Rhisis/blob/644d0a0e82ac107b8b472a261eacd90cc0e0e226/src/Rhisis.Network/Packets/World/ChangeJobPacket.cs#L6-L10

This line should be rewrite to indicate a more explicit message:

Packet sent to change the player's job.

We should avoid <cref=""/> tags that causes issues with the XML parser.

Eastrall avatar Dec 10 '19 12:12 Eastrall

You can use cref Tags, i just have to parse differently then. I don't think we need a cref on the same class though.

Kaev avatar Dec 10 '19 19:12 Kaev

I agree. We should explain explicitly what the packet is.

Eastrall avatar Dec 11 '19 08:12 Eastrall