[U-Boot] [RFC PATCH 14/44] image: Export fit_conf_get_prop_node()

Simon Glass
2013-03-18T21:57:58Z

Hi Marek,

On Mon, Mar 18, 2013 at 2:19 PM, Marek Vasut <marex@denx.de> wrote:
> Dear Simon Glass,
>
>> Hi Marek,
>>
>> On Sat, Jan 5, 2013 at 12:12 AM, Marek Vasut <marex@denx.de> wrote:
>> > Dear Simon Glass,
>> >
>> >> This function will be needed by signature checking code, so export it,
>> >> and also add docs.
>> >>
>> >> Signed-off-by: Simon Glass <sjg@chromium.org>
>> >
>> > [...]
>> >
>> >> +/**
>> >> + * fit_conf_get_prop_node() - Get node refered to by a configuration
>> >> + *
>> >> + * The conf@ nodes contain references to other nodes, using properties
>> >> + * like 'kernel = "kernel at 1"'. Given such a property name (e.g.
>> >> "kernel"), + * return the offset of the node referred to (e.g. offset
>> >> of node + * "/images/kernel at 1".
>> >> + *
>> >> + * @fit: FIT to check
>> >> + * @noffset: Offset of conf at xxx node to check
>> >> + * @prop_name: Property to read from the conf node
>> >
>> > This parameter list is swapped with the description.
>>
>> Sorry, can you please explain that a bit more. I'm not sure what you
>> are pointing to.
>
> Tough question, especially if asked after such time ;-) I believe I meant the
> form of the comment should be like this:
>
> /*
> * foo() - Do baz and bar
> * @parm1: Number of sharks with lasers
> * @parm2: Make the result even cooler
> *
> * Long boring description of the function doing baz and bar.
> */
>
> I think it makes more sense to stick the function param explanation just
> underneath the function name, no?

Aha I see, thank you.

Yes it has been a while - I feel people have had enough time to take a
look and raise questions and it is time for v2.

Regards,
Simon