Skip to content

Commit c616a0d

Browse files
committed
Update the api name, will be change in future
1 parent 4f3c9d2 commit c616a0d

30 files changed

+227
-227
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ int main(int argc, char *argv[])
1919

2020
// The following function cleans up the input path and writes it
2121
// to the result buffer.
22-
cpj_path_normalize( "/var/log/weird/////path/.././..///", result,
22+
cpj_path_normalize_test( "/var/log/weird/////path/.././..///", result,
2323
sizeof(result));
2424

2525
printf("%s\n", result);

docs/reference/cwk_path_change_basename.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: cpj_path_change_basename
2+
title: cpj_path_change_basename_test
33
description: Changes the basename of a file path.
44
---
55

@@ -8,7 +8,7 @@ Changes the basename of a file path.
88

99
## Description
1010
```c
11-
size_t cpj_path_change_basename(const char *path, const char *new_basename,
11+
size_t cpj_path_change_basename_test(const char *path, const char *new_basename,
1212
char *buffer, size_t buffer_size);
1313
```
1414
@@ -20,7 +20,7 @@ have, even if it was not written out completely. The path may be the same
2020
memory address as the buffer.
2121
2222
**Note:** This function does not normalize the resulting path. You can use
23-
**[cpj_path_normalize]({{ site.baseurl }}{% link reference/cpj_path_normalize.md %})**
23+
**[cpj_path_normalize_test]({{ site.baseurl }}{% link reference/cpj_path_normalize_test.md %})**
2424
to do so. Separators before and after the submitted basename will be trimmed,
2525
but not removed from the source path. The value may contain separators which
2626
will introduce new segments. If the submitted path does not have any segments,
@@ -46,7 +46,7 @@ int main(int argc, char *argv[])
4646
{
4747
char buffer[FILENAME_MAX];
4848
49-
cpj_path_change_basename(CPJ_STYLE_WINDOWS, "C:\\test.txt", "another.txt", buffer,
49+
cpj_path_change_basename_test(CPJ_STYLE_WINDOWS, "C:\\test.txt", "another.txt", buffer,
5050
sizeof(buffer));
5151
5252
printf("The new path: '%s'", buffer);

docs/reference/cwk_path_change_extension.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: cpj_path_change_extension
2+
title: cpj_path_change_extension_test
33
description: Changes the extension of a file path.
44
---
55

@@ -8,7 +8,7 @@ Changes the extension of a file path.
88

99
## Description
1010
```c
11-
size_t cpj_path_change_extension(const char *path, const char *new_extension,
11+
size_t cpj_path_change_extension_test(const char *path, const char *new_extension,
1212
char *buffer, size_t buffer_size);
1313
```
1414
@@ -22,7 +22,7 @@ have, even if it was not written out completely. The path may be the same
2222
memory address as the buffer.
2323
2424
**Note:** This function does not normalize the resulting path. You can use
25-
**[cpj_path_normalize]({{ site.baseurl }}{% link reference/cpj_path_normalize.md %})**
25+
**[cpj_path_normalize_test]({{ site.baseurl }}{% link reference/cpj_path_normalize_test.md %})**
2626
to do so.
2727
2828
**Note:** If the ``new_extension`` parameter starts with a dot, the first dot will
@@ -48,7 +48,7 @@ int main(int argc, char *argv[])
4848
{
4949
char buffer[FILENAME_MAX];
5050
51-
cpj_path_change_extension(CPJ_STYLE_WINDOWS, "C:\\test.txt", "md", buffer,
51+
cpj_path_change_extension_test(CPJ_STYLE_WINDOWS, "C:\\test.txt", "md", buffer,
5252
sizeof(buffer));
5353
5454
printf("The new path: '%s'", buffer);

docs/reference/cwk_path_change_root.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: cpj_path_change_root
2+
title: cpj_path_change_root_test
33
description: Changes the root of a path.
44
---
55

@@ -8,7 +8,7 @@ Changes the root of a path.
88

99
## Description
1010
```c
11-
size_t cpj_path_change_root(const char *path, const char *new_root,
11+
size_t cpj_path_change_root_test(const char *path, const char *new_root,
1212
char *buffer, size_t buffer_size);
1313
```
1414
@@ -20,7 +20,7 @@ characters which the resulting path would take if it was not truncated
2020
(excluding the null-terminating character).
2121
2222
**Note:** This function does not normalize the resulting path. You can use
23-
**[cpj_path_normalize]({{ site.baseurl }}{% link reference/cpj_path_normalize.md %})**
23+
**[cpj_path_normalize_test]({{ site.baseurl }}{% link reference/cpj_path_normalize_test.md %})**
2424
to do so. The new root may contain separators which will introduce new segments.
2525
If the submitted path does not have any root, the new root will be prepended to
2626
the path.
@@ -46,7 +46,7 @@ int main(int argc, char *argv[])
4646
{
4747
char buffer[FILENAME_MAX];
4848
49-
cpj_path_change_root(CPJ_STYLE_WINDOWS, "C:\\test.txt", "D:\\", buffer,
49+
cpj_path_change_root_test(CPJ_STYLE_WINDOWS, "C:\\test.txt", "D:\\", buffer,
5050
sizeof(buffer));
5151
5252
printf("The new path: '%s'", buffer);

docs/reference/cwk_path_change_segment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ submitted buffer size, but it is always null-terminated. The source of the
2020
segment and the submitted buffer may be the same.
2121
2222
**Note:** This function does not normalize the resulting path. You can use
23-
**[cpj_path_normalize]({{ site.baseurl }}{% link reference/cpj_path_normalize.md %})**
23+
**[cpj_path_normalize_test]({{ site.baseurl }}{% link reference/cpj_path_normalize_test.md %})**
2424
to do so. Separators before and after the value will be trimmed. The value may
2525
contain separators which will introduce new segments.
2626

docs/reference/cwk_path_get_absolute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: cpj_path_get_absolute
2+
title: cpj_path_get_absolute_test
33
description: Generates an absolute path based on a base.
44
---
55

@@ -8,7 +8,7 @@ Generates an absolute path based on a base.
88

99
## Description
1010
```c
11-
size_t cpj_path_get_absolute(const char *base, const char *path, char *buffer,
11+
size_t cpj_path_get_absolute_test(const char *base, const char *path, char *buffer,
1212
size_t buffer_size);
1313
```
1414
@@ -45,7 +45,7 @@ int main(int argc, char *argv[])
4545
{
4646
char buffer[FILENAME_MAX];
4747
48-
cpj_path_get_absolute("/hello/there", "./world", buffer, sizeof(buffer));
48+
cpj_path_get_absolute_test("/hello/there", "./world", buffer, sizeof(buffer));
4949
printf("The absolute path is: %s", buffer);
5050
5151
return EXIT_SUCCESS;

docs/reference/cwk_path_get_basename.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: cpj_path_get_basename
2+
title: cpj_path_get_basename_test
33
description: Gets the basename of a file path.
44
---
55

@@ -8,7 +8,7 @@ Gets the basename of a file path.
88

99
## Description
1010
```c
11-
void cpj_path_get_basename(const char *path, const char **basename,
11+
void cpj_path_get_basename_test(const char *path, const char **basename,
1212
size_t *length);
1313
```
1414
@@ -44,7 +44,7 @@ int main(int argc, char *argv[])
4444
const char *basename;
4545
size_t length;
4646
47-
cpj_path_get_basename("/my/path.txt", &basename, &length);
47+
cpj_path_get_basename_test("/my/path.txt", &basename, &length);
4848
printf("The basename is: '%.*s'", length, basename);
4949
5050
return EXIT_SUCCESS;

docs/reference/cwk_path_get_dirname.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: cpj_path_get_dirname
2+
title: cpj_path_get_dirname_test
33
description: Gets the dirname of a file path.
44
---
55

@@ -8,7 +8,7 @@ Gets the dirname of a file path.
88

99
## Description
1010
```c
11-
void cpj_path_get_dirname(const char *path, size_t *length);
11+
void cpj_path_get_dirname_test(const char *path, size_t *length);
1212
```
1313
1414
This function determines the dirname of a file path and returns the length up to which character is considered to be part of it. The dirname is the part of the path up to the last segment. For instance, `/var/` is the dirname of `/var/logs`. If no dirname is found, the length will be set to zero. The beginning of the dirname is always equal to the submitted path pointer.
@@ -45,7 +45,7 @@ int main(int argc, char *argv[])
4545
size_t length;
4646
4747
path = "/my/path.txt";
48-
cpj_path_get_dirname(path, &length);
48+
cpj_path_get_dirname_test(path, &length);
4949
printf("The dirname is: '%.*s'", length, path);
5050
5151
return EXIT_SUCCESS;

docs/reference/cwk_path_get_extension.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: cpj_path_get_extension
2+
title: cpj_path_get_extension_test
33
description: Gets the extension of a file path.
44
---
55

@@ -8,7 +8,7 @@ Gets the extension of a file path.
88

99
## Description
1010
```c
11-
bool cpj_path_get_extension(const char *path, const char **extension, size_t *length);
11+
bool cpj_path_get_extension_test(const char *path, const char **extension, size_t *length);
1212
```
1313
1414
This function extracts the extension portion of a file path. A pointer to the beginning of the extension will be returned through the extension parameter if an extension is found and true is returned. This pointer will be positioned on the dot. The length of the extension name will be returned through the length parameter. If no extension is found both parameters won't be touched and false will be returned.
@@ -41,7 +41,7 @@ int main(int argc, char *argv[])
4141
size_t length;
4242
4343
path = "/my/path.txt";
44-
cpj_path_get_extension(path, &extension, &length);
44+
cpj_path_get_extension_test(path, &extension, &length);
4545
printf("The extension is: '%.*s'", length, path);
4646
4747
return EXIT_SUCCESS;

docs/reference/cwk_path_get_relative.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: cpj_path_get_relative
2+
title: cpj_path_get_relative_test
33
description: Generates a relative path based on a base.
44
---
55

@@ -8,7 +8,7 @@ Generates a relative path based on a base.
88

99
## Description
1010
```c
11-
size_t cpj_path_get_relative(const char *base_directory, const char *path,
11+
size_t cpj_path_get_relative_test(const char *base_directory, const char *path,
1212
char *buffer, size_t buffer_size);
1313
```
1414
@@ -50,7 +50,7 @@ int main(int argc, char *argv[])
5050
{
5151
char buffer[FILENAME_MAX];
5252
53-
cpj_path_get_relative("/hello/there/", "/hello/world", buffer, sizeof(buffer));
53+
cpj_path_get_relative_test("/hello/there/", "/hello/world", buffer, sizeof(buffer));
5454
printf("The relative path is: %s", buffer);
5555
5656
return EXIT_SUCCESS;

0 commit comments

Comments
 (0)