Recent changes to Home

Discussion for Home page

TimoM — Sun, 06 Sep 2015 21:35:05 -0000

Forgot to reply to this discussion that a resolution to the problem was found and I fixed the instructions in Wiki page. Apparently there was a change in Doxygen's internal behaviour in v1.8.8 - since then one needs to add
EXTENSION_MAPPING = proto=C
That way Doxygen will use C language parser for .proto files and combined with this filter the files get proper Doxygen output.

Home modified by TimoM

TimoM — Mon, 27 Jul 2015 16:12:00 -0000

--- v12
+++ v13
@@ -9,9 +9,11 @@
     * `JAVADOC_AUTOBRIEF      = YES`
 3. In the Doxygen configuration file, find `FILE_PATTERNS` and add `*.proto`
     * `FILE_PATTERNS = *.proto`
-4. In the Doxygen configuration file, find `INPUT_FILTER` and add proto2cpp.py script
+4. In the Doxygen configuration file, find `EXTENSION_MAPPING` and add `proto=C`
+    * `EXTENSION_MAPPING      = proto=C`
+5. In the Doxygen configuration file, find `INPUT_FILTER` and add proto2cpp.py script
     * `INPUT_FILTER = "python proto2cpp.py"`
-5. Run Doxygen with the modified configuration
+6. Run Doxygen with the modified configuration
     * `doxygen doxyfile`

@@ -48,27 +50,22 @@

 * Windows 7 Home Premium (64 bit)
     - Doxygen version 1.8.8
-    - **NOTE: The script (v0.5-beta) does not work with this Doxygen version!**
     - Python version 3.3.1 (64 bit)

 * Windows 7 Home Premium (64 bit)
     - Doxygen version 1.8.9
-    - **NOTE: The script (v0.5-beta) does not work with this Doxygen version!**
     - Python version 3.3.1 (64 bit)

 * Windows 7 Home Premium (64 bit)
     - Doxygen version 1.8.9.1
-    - **NOTE: The script (v0.5-beta) does not work with this Doxygen version!**
     - Python version 3.3.1 (64 bit)

 * Windows 7 Home Premium (64 bit)
     - Doxygen version 1.8.10
-    - **NOTE: The script (v0.5-beta, v0.6-beta) does not work with this Doxygen version!**
     - Python version 3.3.1 (64 bit)

 * Ubuntu 10.04 LTS (32 bit)
     - Doxygen version 1.8.10
-    - **NOTE: The script (v0.6-beta) does not work with this Doxygen version"**
     - Python version 2.6.5

 [[project_admins]]

Home modified by TimoM

TimoM — Mon, 27 Jul 2015 12:35:17 -0000

--- v11
+++ v12
@@ -2,17 +2,18 @@
 The script is released under GNU Lesser General Public License version 2.1.

 How to enable this filter in Doxygen:
+
 1. Generate Doxygen configuration file with command `doxygen -g <filename>`
-    - e.g.  `doxygen -g doxyfile`
-2. In the Doxygen configuration file, find `JAVADOC_AUTOBRIEF` and set it enabled
-    - `JAVADOC_AUTOBRIEF      = YES`
-   This is required since version 0.6-beta
+    * e.g.  `doxygen -g doxyfile`
+2. In the Doxygen configuration file, find `JAVADOC_AUTOBRIEF` and set it enabled (this is required since version 0.6-beta)
+    * `JAVADOC_AUTOBRIEF      = YES`
 3. In the Doxygen configuration file, find `FILE_PATTERNS` and add `*.proto`
-    - `FILE_PATTERNS = *.proto`
+    * `FILE_PATTERNS = *.proto`
 4. In the Doxygen configuration file, find `INPUT_FILTER` and add proto2cpp.py script
-    - `INPUT_FILTER = "python proto2cpp.py"`
+    * `INPUT_FILTER = "python proto2cpp.py"`
 5. Run Doxygen with the modified configuration
-    - `doxygen doxyfile`
+    * `doxygen doxyfile`
+

 If Doxygen output for the script itself is wanted, `FULL_PATH_NAMES` in the Doxygen configuration should have value `YES` since the script will skip the files named `proto2cpp.py`.

Home modified by TimoM

TimoM — Mon, 27 Jul 2015 12:28:33 -0000

--- v10
+++ v11
@@ -4,11 +4,14 @@
 How to enable this filter in Doxygen:
 1. Generate Doxygen configuration file with command `doxygen -g <filename>`
     - e.g.  `doxygen -g doxyfile`
-2. In the Doxygen configuration file, find `FILE_PATTERNS` and add `*.proto`
+2. In the Doxygen configuration file, find `JAVADOC_AUTOBRIEF` and set it enabled
+    - `JAVADOC_AUTOBRIEF      = YES`
+   This is required since version 0.6-beta
+3. In the Doxygen configuration file, find `FILE_PATTERNS` and add `*.proto`
     - `FILE_PATTERNS = *.proto`
-3. In the Doxygen configuration file, find `INPUT_FILTER` and add proto2cpp.py script
+4. In the Doxygen configuration file, find `INPUT_FILTER` and add proto2cpp.py script
     - `INPUT_FILTER = "python proto2cpp.py"`
-4. Run Doxygen with the modified configuration
+5. Run Doxygen with the modified configuration
     - `doxygen doxyfile`

 If Doxygen output for the script itself is wanted, `FULL_PATH_NAMES` in the Doxygen configuration should have value `YES` since the script will skip the files named `proto2cpp.py`.
@@ -59,8 +62,13 @@

 * Windows 7 Home Premium (64 bit)
     - Doxygen version 1.8.10
-    - **NOTE: The script (v0.5-beta) does not work with this Doxygen version!**
+    - **NOTE: The script (v0.5-beta, v0.6-beta) does not work with this Doxygen version!**
     - Python version 3.3.1 (64 bit)
+
+* Ubuntu 10.04 LTS (32 bit)
+    - Doxygen version 1.8.10
+    - **NOTE: The script (v0.6-beta) does not work with this Doxygen version"**
+    - Python version 2.6.5

 [[project_admins]]
 [[download_button]]

Home modified by TimoM

TimoM — Sun, 26 Jul 2015 17:57:03 -0000

--- v9
+++ v10
@@ -57,5 +57,10 @@
     - **NOTE: The script (v0.5-beta) does not work with this Doxygen version!**
     - Python version 3.3.1 (64 bit)

+* Windows 7 Home Premium (64 bit)
+    - Doxygen version 1.8.10
+    - **NOTE: The script (v0.5-beta) does not work with this Doxygen version!**
+    - Python version 3.3.1 (64 bit)
+
 [[project_admins]]
 [[download_button]]

Home modified by TimoM

TimoM — Thu, 07 May 2015 19:29:46 -0000

--- v8
+++ v9
@@ -34,5 +34,28 @@
     - Doxygen version 1.8.3.1
     - Python version 3.3.1 (64 bit)

+* Windows 7 Home Premium (64 bit)
+    - Doxygen version 1.8.6
+    - Python version 3.3.1 (64 bit)
+
+* Windows 7 Home Premium (64 bit)
+    - Doxygen version 1.8.7
+    - Python version 3.3.1 (64 bit)
+
+* Windows 7 Home Premium (64 bit)
+    - Doxygen version 1.8.8
+    - **NOTE: The script (v0.5-beta) does not work with this Doxygen version!**
+    - Python version 3.3.1 (64 bit)
+
+* Windows 7 Home Premium (64 bit)
+    - Doxygen version 1.8.9
+    - **NOTE: The script (v0.5-beta) does not work with this Doxygen version!**
+    - Python version 3.3.1 (64 bit)
+
+* Windows 7 Home Premium (64 bit)
+    - Doxygen version 1.8.9.1
+    - **NOTE: The script (v0.5-beta) does not work with this Doxygen version!**
+    - Python version 3.3.1 (64 bit)
+
 [[project_admins]]
 [[download_button]]

Discussion for Home page

TimoM — Sun, 26 Apr 2015 20:32:47 -0000

Hi,
Thanks for your feedback.
Indeed it seems that the filter doesn't work with Doxygen v1.8.9.1. Unfortunately I don't have a quick-fix to provide, I'll have to take a deeper look at what has changed in Doxygen.

Discussion for Home page

FlorianWolters — Thu, 23 Apr 2015 14:31:32 -0000

I can't get the example provided in the download file to work with Doxygen v1.8.9.1 and proto2cpp v0.5-beta. If i open the file html/index.html I can not see any documentation. I've enabled logging and pasted the output of the generated proto2cpp.log file here. Did something change regarding filtering in Doxygen? Do you know how-to fix it? Or do I have wrong expectations regarding this project?

Home modified by TimoM

TimoM — Thu, 05 Sep 2013 20:45:53 -0000

--- v7
+++ v8
@@ -11,6 +11,7 @@
 4. Run Doxygen with the modified configuration
     - `doxygen doxyfile`

+If Doxygen output for the script itself is wanted, `FULL_PATH_NAMES` in the Doxygen configuration should have value `YES` since the script will skip the files named `proto2cpp.py`.

 The tarball available as well as Code section contains the filter (`proto2cpp.py`), an example `.proto` file, an example Doxygen configuration file, and a copy of GNU Lesser General Public License version 2.1.

Home modified by TimoM

TimoM — Fri, 30 Aug 2013 11:14:10 -0000

--- v6
+++ v7
@@ -11,8 +11,6 @@
 4. Run Doxygen with the modified configuration
     - `doxygen doxyfile`

-
-Currently (version 0.4-beta) the script searches for .proto files from the pwd.

 The tarball available as well as Code section contains the filter (`proto2cpp.py`), an example `.proto` file, an example Doxygen configuration file, and a copy of GNU Lesser General Public License version 2.1.