Skip to content

Commit

Permalink
Fix page titles in spec build
Browse files Browse the repository at this point in the history
  • Loading branch information
jonrecker authored and mav-intel committed Dec 19, 2023
1 parent 9b1cd49 commit 371864b
Show file tree
Hide file tree
Showing 31 changed files with 919 additions and 920 deletions.
1 change: 0 additions & 1 deletion .github/workflows/specification.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,6 @@ jobs:

pdf:
name: PDF
if: false
needs:
- required_checks
runs-on: [self-hosted, linux]
Expand Down
2 changes: 1 addition & 1 deletion doc/spec/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "Intel® VPL"
PROJECT_NAME = "Intel\u00AE VPL"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down
2 changes: 1 addition & 1 deletion doc/spec/element_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -140,5 +140,5 @@

# -- Options for breathe extension -------------------------------------------

breathe_projects = {project: '../doxygen/xml'} # noqa: F821
breathe_projects = {'DEF_BREATHE_PROJECT': '../doxygen/xml'} # noqa: F821
breathe_default_project = 'none'
38 changes: 19 additions & 19 deletions doc/spec/source/API_ref/VPL_defines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,58 +18,58 @@ API
:depth: 1

.. doxygendefine:: MFX_DECODERDESCRIPTION_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_DEVICEDESCRIPTION_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_ENCODERDESCRIPTION_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_FRAMESURFACE1_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_FRAMESURFACEINTERFACE_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_IMPLDESCRIPTION_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_LEGACY_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_STRUCT_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_VARIANT_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_VERSION_MAJOR
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_VERSION_MINOR
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_VPPDESCRIPTION_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine:: MFX_SURFACEARRAY_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

.. doxygendefine::MFX_ACCELERATIONMODESCRIPTION_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
.. doxygendefine::MFX_POOLPOLICYDESCRIPTION_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
.. doxygendefine::MFX_EXTENDEDDEVICEID_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
.. doxygendefine::MFX_ENCODESTATSCONTAINER_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
.. doxygendefine::MFX_REFINTERFACE_VERSION
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
16 changes: 8 additions & 8 deletions doc/spec/source/API_ref/VPL_disp_api_def.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,43 +22,43 @@ MFX_IMPL_NAME_LEN
-----------------

.. doxygendefine:: MFX_IMPL_NAME_LEN
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFX_STRFIELD_LEN
----------------
.. doxygendefine:: MFX_STRFIELD_LEN
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

Helper macro definitions to add property with single value.

MFX_ADD_PROPERTY_U32
--------------------
.. doxygendefine:: MFX_ADD_PROPERTY_U32
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFX_ADD_PROPERTY_U16
--------------------
.. doxygendefine:: MFX_ADD_PROPERTY_U16
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFX_ADD_PROPERTY_PTR
--------------------
.. doxygendefine:: MFX_ADD_PROPERTY_PTR
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

Helper macro definitions to update existing property.

MFX_UPDATE_PROPERTY_U32
-----------------------
.. doxygendefine:: MFX_UPDATE_PROPERTY_U32
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFX_UPDATE_PROPERTY_U16
-----------------------
.. doxygendefine:: MFX_UPDATE_PROPERTY_U16
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFX_UPDATE_PROPERTY_PTR
-----------------------
.. doxygendefine:: MFX_UPDATE_PROPERTY_PTR
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
6 changes: 3 additions & 3 deletions doc/spec/source/API_ref/VPL_disp_api_enum.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ mfxAccelerationMode
-------------------

.. doxygenenum:: mfxAccelerationMode
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

mfxImplType
-----------

.. doxygenenum:: mfxImplType
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

mfxAutoSelectImplType
---------------------

.. doxygenenum:: mfxAutoSelectImplType
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
14 changes: 7 additions & 7 deletions doc/spec/source/API_ref/VPL_disp_api_func.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,40 +22,40 @@ MFXCreateConfig
---------------

.. doxygenfunction:: MFXCreateConfig
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFXCreateSession
----------------

.. doxygenfunction:: MFXCreateSession
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFXDispReleaseImplDescription
-----------------------------

.. doxygenfunction:: MFXDispReleaseImplDescription
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFXEnumImplementations
----------------------

.. doxygenfunction:: MFXEnumImplementations
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFXLoad
-------

.. doxygenfunction:: MFXLoad
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFXSetConfigFilterProperty
--------------------------

.. doxygenfunction:: MFXSetConfigFilterProperty
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

MFXUnload
---------

.. doxygenfunction:: MFXUnload
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
24 changes: 12 additions & 12 deletions doc/spec/source/API_ref/VPL_disp_api_struct.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,89 +22,89 @@ mfxDecoderDescription
---------------------

.. doxygenstruct:: mfxDecoderDescription
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

mfxDeviceDescription
--------------------

.. doxygenstruct:: mfxDeviceDescription
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

mfxEncoderDescription
---------------------

.. doxygenstruct:: mfxEncoderDescription
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

mfxImplDescription
------------------

.. doxygenstruct:: mfxImplDescription
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

mfxVariant
----------

.. doxygenstruct:: mfxVariant
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

.. doxygenenum:: mfxVariantType
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT

mfxVPPDescription
-----------------

.. doxygenstruct:: mfxVPPDescription
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

mfxAccelerationModeDescription
------------------------------

.. doxygenstruct:: mfxAccelerationModeDescription
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

mfxImplementedFunctions
-----------------------

.. doxygenstruct:: mfxImplementedFunctions
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

mfxExtendedDeviceId
-------------------

.. doxygenstruct:: mfxExtendedDeviceId
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

mfxPoolPolicyDescription
------------------------

.. doxygenstruct:: mfxPoolPolicyDescription
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:

extDeviceUUID
-------------

.. doxygenstruct:: extDeviceUUID
:project: Intel® VPL
:project: DEF_BREATHE_PROJECT
:members:
:protected-members:
Loading

0 comments on commit 371864b

Please sign in to comment.