[Ferite-devel] Documentation Changes

[Chris R. <ch...@da...>]

I have changed the format for the documentation tags for generating
documentation.

Instead of !function, !class etc it is now @function, @class.

This has meant the updating of all the documentation comments within
ferite source code. For those with third party modules wanting to up
date the comments with the minimum of fuss, please use this bash
script:

for file in `find . -name "*.fec"`; \
do cat $file | sed -e "s/\!function/@function/g;" \
                    -e "s/\!brief/@brief/g;" \
                    -e "s/\!declaration/@declaration/g;" \
                    -e "s/\!description/@description/g;" \
                    -e "s/\!static/@static/g;" \
                    -e "s/\!warning/@warning/g;" \
                    -e "s/\!example/@example/g;" \
                    -e "s/\!return/@return/g;" \
                    -e "s/\!param/@param/g;" \
                    -e "s/\!variable/@variable/g;" \
                    -e "s/\!type/@type/g;" \
                    -e "s/\!namespace/@namespace/g;" \
                    -e "s/\!modifies/@modifies/g;" \
                    -e "s/\!group/@group/g;" \
                    -e "s/\!class/@class/g;" \
                    -e "s/\!extends/@extends/g;" \
                    -e "s/\!end/@end/g;" > $file.new; mv $file.new $file;
done

Hope this makes the headache easier,

Regards,

Chris