Hi,

I just realized a problem in comment blocks at the beginnings of many of
our files, especially the newer CA branch ones.

The comments start:

/******************************************************************
 *
 * Copyright 2014 Samsung Electronics All Rights Reserved.
 *
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
...


The problem with that lies in the first line. Technically it is a doc
comment, so will trigger Doxygen to process the entire block and attach
it to random areas of the generated output.

It's actually a fairly common error in projects that are just getting
going with Doxygen or such. The simple correction is to change the
start-of-file comment block. And the simplest way is to change the third
character to a space:

/* ****************************************************************
 *
 * Copyright 2014 Samsung Electronics All Rights Reserved.
 *
...


For developers who are not used to checking the final Doxygen output
that is very easy to miss. Becoming aware of this and heading off the
problem early will also help people looking into using IoTivity code
feel more secure about the level of professionalism of the codebase.


-- 
Jon A. Cruz - Senior Open Source Developer
Samsung Open Source Group
jonc at osg.samsung.com

Reply via email to