[jira] [Commented] (AVRO-2222) Avro C++ documentation is missing code snippets

2018-10-02 Thread ASF subversion and git services (JIRA)


[ 
https://issues.apache.org/jira/browse/AVRO-?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16635777#comment-16635777
 ] 

ASF subversion and git services commented on AVRO-:
---

Commit a943df760f6df520702a54e9b061e98250172c8e in avro's branch 
refs/heads/master from Thiruvalluvan M G
[ https://gitbox.apache.org/repos/asf?p=avro.git;h=a943df7 ]

Merge pull request #338 from apache/AVRO--doxygen-fix

Fixed doxygen

> Avro C++ documentation is missing code snippets
> ---
>
> Key: AVRO-
> URL: https://issues.apache.org/jira/browse/AVRO-
> Project: Avro
>  Issue Type: Bug
>  Components: c++
>Affects Versions: 1.8.0, 1.8.1, 1.8.2, 1.8.3, 1.8.4
>Reporter: Rui Maciel
>Assignee: Darryl Green
>Priority: Major
> Attachments: 
> 0001-AVRO--Avro-C-documentation-is-missing-code-snipp.patch
>
>
> The Apache Avro C++ Documentation page[¹] includes an example on how to use 
> Avro with C++ but unfortunately most code snippets are missing, which renders 
> the document unusable.
>  
> [¹]http://avro.apache.org/docs/1.8.2/api/cpp/html/index.html



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


[jira] [Commented] (AVRO-2222) Avro C++ documentation is missing code snippets

2018-10-01 Thread Darryl Green (JIRA)


[ 
https://issues.apache.org/jira/browse/AVRO-?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16633719#comment-16633719
 ] 

Darryl Green commented on AVRO-:


This seems to have been broken in a massive 83 file commit that was apparently 
only supposed to update license files - the 1.7.7 docs are ok, the 1.8.0 and 
later are broken.

[https://github.com/apache/avro/commit/58f8b341413ef25116bf29d283bd703c3c1a9c2f#diff-4dea549538700173d7a7ba1f02ddcc0e]

The commit removed most of the content of the Doxyfile and in particular 
removed:

EXAMPLE_PATH = examples

Attached patch reinstates that line which results in build.sh doc producing 
correct (well, with the examples included anyway) docs...

 

 

> Avro C++ documentation is missing code snippets
> ---
>
> Key: AVRO-
> URL: https://issues.apache.org/jira/browse/AVRO-
> Project: Avro
>  Issue Type: Bug
>  Components: c++
>Affects Versions: 1.8.0, 1.8.1, 1.8.2, 1.8.3, 1.8.4
>Reporter: Rui Maciel
>Assignee: Darryl Green
>Priority: Major
> Attachments: 
> 0001-AVRO--Avro-C-documentation-is-missing-code-snipp.patch
>
>
> The Apache Avro C++ Documentation page[¹] includes an example on how to use 
> Avro with C++ but unfortunately most code snippets are missing, which renders 
> the document unusable.
>  
> [¹]http://avro.apache.org/docs/1.8.2/api/cpp/html/index.html



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