Functions

List of functions in the ude.doxygen_lock namespace.

Entity Name	Description
_is_pid_alive	Checks whether a process with the given PID currently exists.
publish_atomically	Publishes `tmp_dir` as `final_dir` so readers never observe a half-written directory.

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

Entity Name	Summary / Description
_is_pid_alive function	Checks whether a process with the given PID currently exists. Windows uses `ctypes` + `OpenProcess`, deliberately NOT `os.kill(pid, 0)`: on Windows, `os.kill` has no “signal 0 = existence check” semantics – for any signal other than `CTRL_C_EVENT`/`CTRL_BREAK_EVENT` it calls `TerminateProcess`, which would kill the very Doxygen process this function is meant to merely check on. POSIX uses the standard `os.kill(pid, 0)` idiom instead, which is safe there. Returns: True if the process exists (including “exists but access denied”,
publish_atomically function	Publishes `tmp_dir` as `final_dir` so readers never observe a half-written directory. A single `os.replace()` is atomic on both platforms only when `final_dir` does not yet exist; a directory can’t be atomically “merged” or overwritten in place. When `final_dir` already holds a previous run’s output, it is first renamed aside (a second atomic op) and removed only after the new content is in place – never merged, so orphaned files from a previous run (which `DoxygenXmlParser.parse()`’s directory-scan fallback could otherwise pick up) cannot survive a publish.

_is_pid_alive function

Checks whether a process with the given PID currently exists.

Windows uses ctypes + OpenProcess, deliberately NOT os.kill(pid, 0): on Windows, os.kill has no “signal 0 = existence check” semantics – for any signal other than CTRL_C_EVENT/CTRL_BREAK_EVENT it calls TerminateProcess, which would kill the very Doxygen process this function is meant to merely check on. POSIX uses the standard os.kill(pid, 0) idiom instead, which is safe there.

Returns:

True if the process exists (including “exists but access denied”,

publish_atomically function

Publishes tmp_dir as final_dir so readers never observe a half-written directory.

A single os.replace() is atomic on both platforms only when final_dir does not yet exist; a directory can’t be atomically “merged” or overwritten in place. When final_dir already holds a previous run’s output, it is first renamed aside (a second atomic op) and removed only after the new content is in place – never merged, so orphaned files from a previous run (which DoxygenXmlParser.parse()’s directory-scan fallback could otherwise pick up) cannot survive a publish.