Re: Protocols/Generics/ review

Hi Petr,

I’ve made several changes and pushed them to http://bzr.calitko.org/developers/s3rvac/calitko-peter so you can have a look and possibly merge some changes with your branch:

Great! I’ll look at it and merge it!

It seems to me that it’s pretty clear that xIndex and yIndex are two indexes and what the function returns :). But except examples like this there is no problem with it. It would be maybe good to write the comment style into coding conventions.

What about avoiding some redundancy:
/**
* \brief Determines whether the selected position is on the border.
* \param xIndex
* \param yIndex
* \returns true if the selected position is on the border.
* false otherwise.
*/

Actually I see now that \param is preferable to \a (which I’ve used so far). We should use it as it provides parameter checking (see http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam)

Yes, that would be better - I’ll take a look at it (if you don’t prefer to do it yourself ).

I’ll probably be able to change the copy() faster but I guess it will be interesting for you to figure out how packet generation works :-). You’ll have to modify PacketHeader.xsl and PacketSource.xsl.

I’ll read that article and do some search about it and then we can maybe talk about it again.

Great!

Another thing is that it maybe would need to make changes in the whole project code to have/keep it consistent.

That shouldn’t scare us - we should always try to write better and better code even if that would mean we would need to get older code up to date.

Hmm, I’d prefer *Status but I don’t have much experience using this approach yet.

Sometimes the intuitive replies are better ;-). Let’s stick to *Status.

Regards,

Peter

Would you like to post a relpy?


This post is a reply to:
Re: Protocols/Generics/ review
Hi Peter, thanks for that tip with creating a new branch on http://bzr.calitko.org/developers/s3rvac so I can easily express and public my changes in your code! I've made several changes and pushed (more...)

Follow-ups:
Re: Protocols/Generics/ review
Hi Petr, I updated the docs in TcpSocketBuffer to use \param. The Doxygen output looks really nice! //! Writes \a bytes to the write buffer. /*! \param bytes are the bytes that should be (more...)