Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix/long comments #2

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 0 additions & 50 deletions README

This file was deleted.

94 changes: 94 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
Doxygen filter for Google Protocol Buffers .proto files
=======================================================

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:
FILE_PATTERNS = *.proto
3. In the Doxygen configuration file, find EXTENSION_MAPPING and add proto=C++:
EXTENSION_MAPPING = proto=C++
4. In the Doxygen configuration file, find INPUT_FILTER and add this script:
INPUT_FILTER = "python proto2cpp.py"
5. Run Doxygen with the modified configuration:
doxygen doxyfile

Following change is recommended by Timo Marjoniemi but must not be used:
In the Doxygen configuration file, find JAVADOC_AUTOBRIEF and set it enabled:
JAVADOC_AUTOBRIEF = YES

Version history
===============

0.8-beta (2018-12-09) OSI
-------------------------
- Bugfix regarding long comments, remove typo
- Bugfix and extensions have been made by Open Simulation Interface (OSI) Carsten Kuebler https://github.com/OpenSimulationInterface

0.7-beta (2018-04-19) OSI
-------------------------
- Include changes from University of California.
- Support for all OSI *.proto files.
- Separate statement and comments to treat both parts differently (remove bugs
regarding string modifications).
- Remove "option" statements.
- Add support for "extend" statements.
- Change "repeat" from Template to standard member. --> Better collaboration
diagrams.
- Fix problems with references of nested messages (replace "." with "::").
- Change mapping from C to C++.
- Bugfix and extensions have been made by Open Simulation Interface (OSI) Carsten Kuebler https://github.com/OpenSimulationInterface

0.6-beta (2015-07-27)
--------------------
- made output to be more compact by removing extra empty lines and
not moving member comments before the member but keeping it after
the member instead
* these changes lead into need of enabling JAVADOC_AUTOBRIEF
- added steps for enabling the filter in Doxygen in this file

0.5-beta (2014-11-16)
--------------------
- fixed enum ending to have semicolon to have proper enum syntax
in struct (thanks to m47iast for pointing this out)

0.4-beta (2013-08-29)
--------------------
- 'classified' proto2cpp and updated documentation to make the
script itself Doxygen compatible
- changed all print statements to print() functions
* 64-bit Python v3.3.1 running on 64-bit Windows 7 Home Premium
did not automatically convert print statements to print()
functions but instead raised a syntax error
- made a change so that .proto files are converted before printing
and other files are printed to stdout as is
* this allows using the filter with multiple file types

0.3-alpha (2013-01-29)
--------------------
- moved .proto file parsing logic to another function
- added comments to the file

0.2-pre-alpha (2012-06-15)
--------------------
- added support for enums

0.1-pre-alpha (2012-06-13)
--------------------
- initial version


Copyright
=========

Version 0.7-beta -
------------------
Extensions for Open Simulation Interface - License MIT

Version 0.7-beta
----------------
Copyright (C) 2016 Regents of the University of California https://github.com/vgteam/vg

Version 0.1-beta - 0.6-beta
----------------------------
Copyright (C) 2012-2015 Timo Marjoniemi https://sourceforge.net/p/proto2cpp/wiki/Home/
4 changes: 2 additions & 2 deletions doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ PROJECT_NAME = "Protocol Buffers demo project"
# This could be handy for archiving the generated documentation or
# if some version control system is used.

PROJECT_NUMBER = 0.6-beta
PROJECT_NUMBER = 0.7-beta

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
Expand Down Expand Up @@ -238,7 +238,7 @@ OPTIMIZE_OUTPUT_VHDL = NO
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.

EXTENSION_MAPPING = proto=C
EXTENSION_MAPPING = proto=C++

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
Expand Down
Loading