Mir

mir_toolkit C++ namespace is embedded in Doxygen output for the C client API.

Bug #1137170 reported by Daniel van Vugt
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mir
Fix Released
Low
Alan Griffiths
Mir 0.0.3

Bug Description

make doc

Now navigating the generated build/doc/html/namespacemir__toolkit.html and clicking on a function I can see the internal namespace is mentioned:
   mir_toolkit::MirWaitHandle * mir_toolkit::mir_connect(...

Related branches

lp:~alan-griffiths/mir/fix-bug-1137170
PS Jenkins bot (community): Approve (continuous-integration)
Daniel van Vugt: Needs Fixing
Kevin DuBois (community): Approve
Alexandros Frantzis (community): Approve
Diff: 1313 lines (+170/-164)
35 files modified
include/client/mir_toolkit/mir_client_library.h (+4/-5)
include/client/mir_toolkit/mir_client_library_drm.h (+5/-2)
include/client/mir_toolkit/mir_client_library_lightdm.h (+5/-2)
include/shared/mir_toolkit/c_types.h (+5/-2)
include/shared/mir_toolkit/common.h (+6/-1)
include/shared/mir_toolkit/input/event.h (+5/-0)
include/shared/mir_toolkit/mesa/native_display.h (+5/-3)
src/client/android/android_client_buffer_factory.cpp (+1/-1)
src/client/android/android_client_buffer_factory.h (+1/-1)
src/client/android/android_native_display_container.cpp (+6/-6)
src/client/android/android_native_display_container.h (+3/-3)
src/client/client_buffer.h (+6/-4)
src/client/client_buffer_depository.cpp (+1/-1)
src/client/client_buffer_depository.h (+1/-6)
src/client/client_buffer_factory.h (+1/-1)
src/client/client_context.h (+2/-8)
src/client/egl_native_display_container.h (+3/-3)
src/client/gbm/gbm_client_buffer.cpp (+2/-2)
src/client/gbm/gbm_client_buffer.h (+3/-3)
src/client/gbm/gbm_client_buffer_factory.cpp (+1/-1)
src/client/gbm/gbm_client_buffer_factory.h (+1/-1)
src/client/gbm/gbm_client_platform.cpp (+1/-1)
src/client/gbm/mesa_native_display_container.cpp (+9/-9)
src/client/gbm/mesa_native_display_container.h (+4/-4)
src/client/mir_client_library.cpp (+31/-31)
src/client/mir_client_surface.h (+2/-2)
src/client/mir_connection.cpp (+23/-23)
src/client/mir_connection.h (+1/-1)
src/client/mir_surface.cpp (+19/-19)
src/client/mir_surface.h (+1/-1)
src/client/mir_wait_handle.cpp (+5/-5)
src/client/mir_wait_handle.h (+5/-3)
tests/unit-tests/client/gbm/test_mesa_native_display_container.cpp (+1/-1)
tests/unit-tests/client/test_aging_buffer.cpp (+1/-6)
tests/unit-tests/client/test_wait_handle.cpp (+0/-2)
Revision history for this message
Daniel van Vugt (vanvugt) wrote :

See also bug 1137184

summary: - C++ namespace is embedded in Doxygen output for the C client API.
+ mir_toolkit C++ namespace is embedded in Doxygen output for the C client
+ API.
Revision history for this message
Alan Griffiths (alan-griffiths) wrote :

This is a feature, not a bug.

The change was made as to group the C API in doxygen instead of having it mixed with other objects in the global namespace.

Revision history for this message
Daniel van Vugt (vanvugt) wrote :

I disagree. It's a C API so should not mention a C++ namespace in its docs.

Daniel van Vugt (vanvugt)
information type: Proprietary → Public
Alan Griffiths (alan-griffiths)
Changed in mir:
assignee: nobody → Alan Griffiths (alan-griffiths)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

Fix committed into lp:mir at revision None, scheduled for release in mir, milestone Unknown

Changed in mir:
status: New → Fix Committed
Daniel van Vugt (vanvugt)
Changed in mir:
milestone: none → 0.0.3
Robert Ancell (robert-ancell)
Changed in mir:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.