[Freeipa-devel] [PATCH] 451-458 Web UI devel and source code documentation

[Petr Vobornik]

On 09/16/2013 05:24 PM, Ana Krivokapic wrote:
> On 09/11/2013 12:44 PM, Petr Vobornik wrote:
>> Hello,
>>

snip

>>
>
> I looked into the documentation effort and (ruby dependency discussion aside) I
> don't have any major objections. I like how the generated pages look, and they
> are intuitive and easy to navigate.
>
> A couple of nitpicks:
>
> 1) There are some spelling mistakes (e.g. Apllication_controller)
Fixed
>
> 2) Bulleted lists are not rendered nicely in the html output (see for example
> the doc string for _base.Builder property 'string_mode'. I think a list needs to
> look like this in the source code:
>
>          /**
>           * This is a list:
>           *
>           * - 'element1'
>           * - 'element2'
>           *
>           */
>
> as opposed to this:
>
>          /**
>           * This is a list:
>           * - 'element1'
>           * - 'element2'
>           */
>

Fixed on many places. Also fixed the same issue in some code examples.

- _base.Builder doc was heavily revised
- added doc comments to ./plugin_loader

All patches are rebased but just patches 452 and 453 are changed.
-- 
Petr Vobornik
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0458-1-Registries-and-Build-Guide.patch
Type: text/x-patch
Size: 12664 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20131002/f2b2231d/attachment.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0457-1-Navigation-Guide.patch
Type: text/x-patch
Size: 15630 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20131002/f2b2231d/attachment-0001.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0456-1-Plugin-Infrastructure-Guide.patch
Type: text/x-patch
Size: 5022 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20131002/f2b2231d/attachment-0002.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0455-1-Debugging-Web-UI-guide.patch
Type: text/x-patch
Size: 6324 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20131002/f2b2231d/attachment-0003.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0454-1-Phases-Guide.patch
Type: text/x-patch
Size: 9671 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20131002/f2b2231d/attachment-0004.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0453-1-Configuration-for-JSDuck-documentation-generator.patch
Type: text/x-patch
Size: 9540 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20131002/f2b2231d/attachment-0005.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0452-1-Web-UI-source-code-annotation.patch
Type: text/x-patch
Size: 323184 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20131002/f2b2231d/attachment-0006.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0451-1-Removal-of-unused-code.patch
Type: text/x-patch
Size: 1211 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20131002/f2b2231d/attachment-0007.bin>