Improvements to minor mistakes in documentation comments (#3923)

This commit is contained in:
ANF-Studios
2021-03-16 12:30:55 +01:00
committed by ocornut
parent 35b1148efb
commit ebe6ac5fb5
6 changed files with 79 additions and 68 deletions

View File

@ -31,6 +31,17 @@ HOW TO UPDATE?
- Please report any issue!
-----------------------------------------------------------------------
VERSION 1.83 WIP (In Progress)
-----------------------------------------------------------------------
Breaking Changes:
Other Changes:
- Docs: Improvements to minor mistakes in documentation comments (#3923) [@ANF-Studios]
-----------------------------------------------------------------------
VERSION 1.82 (Released 2021-02-15)
-----------------------------------------------------------------------
@ -346,7 +357,7 @@ Breaking Changes:
- Renamed ImGuiSliderFlags_ClampOnInput to ImGuiSliderFlags_AlwaysClamp. Kept redirection enum (will obsolete).
- Renamed OpenPopupContextItem() back to OpenPopupOnItemClick(), REVERTED CHANGE FROM 1.77.
For variety of reason this is more self-explanatory and less error-prone. Kept inline redirection function.
- Removed return value from OpenPopupOnItemClick() - returned true on mouse release on item - because it
- Removed return value from OpenPopupOnItemClick() - returned true on mouse release on an item - because it
is inconsistent with other popups API and makes others misleading. It's also and unnecessary: you can
use IsWindowAppearing() after BeginPopup() for a similar result.
@ -1286,7 +1297,7 @@ Breaking Changes:
- Removed io.DisplayVisibleMin/DisplayVisibleMax (which were marked obsolete and removed from viewport/docking branch already).
- Made it illegal/assert when io.DisplayTime == 0.0f (with an exception for the first frame).
If for some reason your time step calculation gives you a zero value, replace it with a arbitrary small value!
If for some reason your time step calculation gives you a zero value, replace it with a arbitrarily small value!
Other Changes: