[jira] [Commented] (MINIFICPP-691) Improve method of gathering processor documentation and providing to C2

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MINIFICPP-691?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16711663#comment-16711663 ] 

ASF GitHub Bot commented on MINIFICPP-691:
------------------------------------------

GitHub user phrocker opened a pull request:

    https://github.com/apache/nifi-minifi-cpp/pull/457

    MINIFICPP-691: Add method for getting processor description. Internal…

    … API change, but is strictly voluntary for contributors
    
    Based on work from September -- enables us to get a better documentation picture in agent information. Will allow us to eventually auto generate some docs. While this is an internal API call we still don't want to fully break anyone, so I've updated every usage of it in our code base. Further, this is purely optional function to be used, so the risk of making a change to it is minimal. 
    
    Thank you for submitting a contribution to Apache NiFi - MiNiFi C++.
    
    In order to streamline the review of the contribution we ask you
    to ensure the following steps have been taken:
    
    ### For all changes:
    - [ ] Is there a JIRA ticket associated with this PR? Is it referenced
         in the commit message?
    
    - [ ] Does your PR title start with MINIFICPP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
    
    - [ ] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    - [ ] Is your initial contribution a single, squashed commit?
    
    ### For code changes:
    - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
    - [ ] If applicable, have you updated the LICENSE file?
    - [ ] If applicable, have you updated the NOTICE file?
    
    ### For documentation related changes:
    - [ ] Have you ensured that format looks appropriate for the output in which it is rendered?
    
    ### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/phrocker/nifi-minifi-cpp MINIFICPP-691

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/nifi-minifi-cpp/pull/457.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #457
    
----
commit c3bcc1e4ec1a5665d3615fd55869fdaf9ebed53c
Author: Marc Parisi <ph...@...>
Date:   2018-12-06T12:25:37Z

    MINIFICPP-691: Add method for getting processor description. Internal API change, but is strictly voluntary for contributors

----


> Improve method of gathering processor documentation and providing to C2
> -----------------------------------------------------------------------
>
>                 Key: MINIFICPP-691
>                 URL: https://issues.apache.org/jira/browse/MINIFICPP-691
>             Project: NiFi MiNiFi C++
>          Issue Type: Task
>            Reporter: Mr TheSegfault
>            Assignee: Mr TheSegfault
>            Priority: Major
>              Labels: documentation
>             Fix For: 0.6.0
>
>
> Improve method of gathering processor documentation and providing to C2



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)